Procedure Record Files API Example

This example demonstrates how to use the ProcedureRecord API to associate files with procedure records in the GEMINIbase.

Source File Location

The original Python script is located at gemini/examples/api/procedure_record_files_api.py.

Code

from gemini.api.procedure_record import ProcedureRecord
from datetime import datetime, timedelta
from random import randint
import os

# Create Timestamp
timestamp = datetime(1994, 10, 1, 12, 0, 0)  # Fixed timestamp for consistency
timestamp = timestamp + timedelta(hours=randint(0, 23), minutes=randint(0, 59))  # Randomize time within the day

# Get Sample Image Folder
script_folder = os.path.dirname(os.path.abspath(__file__))
sample_image_folder = os.path.join(script_folder, "sample_images")
sample_image_files = [
    os.path.join(sample_image_folder, f) for f in os.listdir(sample_image_folder)
    if os.path.isfile(os.path.join(sample_image_folder, f))
]
print(f"Sample Image Files: {sample_image_files}")

# Creating Records to add to ProcedureRecord
records_to_add = []
for image_file in sample_image_files:
    timestamp = timestamp + timedelta(minutes=randint(1, 60))  # Increment timestamp for each file
    collection_date = timestamp.date()  # Use the date part of the timestamp
    record = ProcedureRecord.create(
        timestamp=timestamp,
        collection_date=collection_date,
        procedure_name="Procedure A",
        dataset_name="Procedure A Images Dataset",
        procedure_data={"key": "value"},
        experiment_name="Experiment A",
        site_name="Site A1",
        season_name="Season 1A",
        record_file=image_file,
        record_info={"test": "test"},
        insert_on_create=False
    )
    records_to_add.append(record)

ProcedureRecord.insert(records_to_add)

# Search the Procedure Records
searched_records = ProcedureRecord.search(
    collection_date=timestamp.date(),
    dataset_name="Procedure A Images Dataset",
    procedure_name="Procedure A",
    experiment_name="Experiment A",
    site_name="Site A1",
    season_name="Season 1A"
)
searched_records = list(searched_records)  # Convert to list to evaluate the generator
# Print the searched records
print(f"Found {len(searched_records)} records in Procedure A, Experiment A, Site A1, Season 1A:")
for record in searched_records:
    print(record)

Explanation

This example demonstrates how to associate files with procedure records using the GEMINIbase API:

• Creating procedure records with files: The ProcedureRecord.create() method is used to create new procedure records, each associated with a file from the sample_images directory. The insert_on_create parameter is set to False to allow batch insertion.
• Inserting procedure records: The ProcedureRecord.insert() method is used to efficiently insert multiple procedure records into the database.
• Searching for procedure records: The ProcedureRecord.search() method is used to find procedure records based on specified criteria.