autowisp.database.data_model package

Class Inheritance Diagram

Inheritance diagram of Condition, ConditionExpression, Configuration, DDL, DataModelBase, HDF5Attribute, HDF5DataSet, HDF5Link, HDF5Product, HDF5StructureVersion, Image, ImageProcessingProgress, ImageType, InputMasterTypes, LightCurveProcessingProgress, LightCurveStatus, MasterFile, MasterType, ObservingSession, Parameter, ProcessedImages, ProcessingSequence, Step, StepDependencies, Target

Add all tables to __all__.

class autowisp.database.data_model.Condition(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.Condition

The table describing the Conditions for given configuration to apply.

Each condition is a combination of condition expressions that must all be satisfied simultaneously for the condition to be considered satisfied.

expression
expression_id

The id of the condition expression that is part of this condition.

id

A unique identifier for each row.

notes

Any user supplied notes describing the condition.

timestamp

When record was last changed

class autowisp.database.data_model.ConditionExpression(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.ConditionExpression

The table describing the Condition Expressions

expression

The expression to evaluate to determine if an image meets the condition.

id

A unique identifier for each row.

notes

Any user supplied notes describing the condition expression.

timestamp

When record was last changed

class autowisp.database.data_model.Configuration(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.Configuration

Table recording the values of the pipeline configuration parameters.

condition_expressions
condition_id

The id of the condition that must be met for this configuration to apply

conditions: Mapped[List[Condition]]
id

A unique identifier for each row.

notes

Any user supplied notes describing the configuration.

parameter
parameter_id

The name of the configuration parameter.

timestamp

When record was last changed

value

The value of the configuration parameter for the given version for images satisfying the given conditions.

version

The version of the configuration parameter. Later versions fall back on earlier versions if an entry for the parameter is not found.

class autowisp.database.data_model.HDF5Attribute(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.HDF5Attribute

The table describing how to add attributes in HDF5 files.

__str__()[source]

Print the contents of the given attribute.

description

A brief description of what this attribute tracks.

dtype

The data type to use for this dataset. See h5py for possible values and their meanings.

hdf5_structure_version_id

Which structure version of which pipeline product is this element configuration for.

id

A unique identifier for each row.

name

The name to give to use for this attribute within the HDF5 file.

parent

The full absolute path to the group or dataset to add this attribute to.

pipeline_key

How is this attribute referred to by the pipeline.

structure_version
timestamp

When record was last changed

class autowisp.database.data_model.HDF5DataSet(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.HDF5DataSet

The table describing how to include datasets in HDF5 files.

__str__()[source]

Human readable description.

abspath

The full absolute path to the dataset within the HDF5 file.

compression

If not NULL, which compression filter to use when creating the dataset.

compression_options

Any options to pass to the compression filter. For gzip, this is passed as int(compression_options).

description

A brief description of what this attribute tracks.

dtype

The data type to use for this dataset. See h5py for possible values and their meanings.

hdf5_structure_version_id

Which structure version of which pipeline product is this element configuration for.

id

A unique identifier for each row.

pipeline_key

How is this dataset referred to by the pipeline.

replace_nonfinite

For numeric datasets, if this is not NULL, any non-finite values are replaced by this value.

scaleoffset

If not null, enable the scale/offset filter for this dataset with the specified precision.

shuffle

Should the shuffle filter be enabled?

structure_version
timestamp

When record was last changed

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.HDF5Link

Table describing links of chosen versions of products in HDF5 files.

abspath

The full absolute path to the link in the HDF5 file.

description

A brief description of what this attribute tracks.

hdf5_structure_version_id

Which structure version of which pipeline product is this element configuration for.

id

A unique identifier for each row.

pipeline_key

How is this link referred to by the pipeline.

structure_version
target

The full absolute path the link should point to.

timestamp

When record was last changed

class autowisp.database.data_model.HDF5Product(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.HDF5Product

The types of pipeline products stored as HDF5 files.

description

A description of the product type.

id

A unique identifier for each row.

pipeline_key

How is this product referred to in the pipeline (e.g. “datareduction” or “lightcurve”

structure_versions
timestamp

When record was last changed

class autowisp.database.data_model.HDF5StructureVersion(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.HDF5StructureVersion

The versions of structures for the HDF5 pipeline products.

attributes
datasets
hdf5_product_id

The type of pipeline product this structure configuration version is for.

id

A unique identifier for each row.

product
timestamp

When record was last changed

version

An identifier for distinguishing the separate configuration versions of a single pipeline product type.

class autowisp.database.data_model.Image(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.Image

The table describing the image specified

id

A unique identifier for each row.

image_type
image_type_id

The id of the image type

notes

The notes provided for the image

observing_session
observing_session_id

The id of the observing session

processing: Mapped[List[ProcessedImages]]
raw_fname

The full path of the raw image

timestamp

When record was last changed

class autowisp.database.data_model.ImageProcessingProgress(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.ImageProcessingProgress

The table describing the Image Processing Progress

applied_to: Mapped[List[ProcessedImages]]
configuration_version

config version of image

finished

The time processing is known to have ended (NULL if possibly still on-going)

host

Hostname or other identifier of the computer where processing is/was done

id

A unique identifier for each row.

image_type
image_type_id

The id of the image type being processed

notes

Any user supplied notes about the processing.

process_id

Identifier of the process performing this calibration step

started

The time processing started

step
step_id

Id of the step that was applied

timestamp

When record was last changed

class autowisp.database.data_model.ImageType(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.ImageType

The table describing the different image types.

description

The description of the image type

id

A unique identifier for each row.

image
name

The image type name

timestamp

When record was last changed

class autowisp.database.data_model.InputMasterTypes(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.InputMasterTypes

The table describing the prerequisites for a step to run

config_name

The name of the configuration parameter that specifies the master when running the specified step.

id

A unique identifier for each row.

image_type
image_type_id

The image type for which this prerequisite applies.

master_type
master_type_id

The master type required for the step to run.

optional

Can processing by the given step of the given types of images can proceed if the given type of master is not found?

step
step_id

The step for which this prerequisite applies.

timestamp

When record was last changed

class autowisp.database.data_model.LightCurveProcessingProgress(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.LightCurveProcessingProgress

The table describing the light curve processing progress

configuration_version

config version of image

final

Is this the final processing status? The only case where status=1 is not final is for magnitude fitting, where there may be additional iterations needed.

finished

The time processing is known to have ended (NULL if possibly still on-going)

host

Hostname or other identifier of the computer where processing is/was done

id

A unique identifier for each row.

notes

Any user supplied notes about the processing.

process_id

Identifier of the process performing this calibration step

single_photref_id

The ID of the single photometric reference for which LC points were processed.

sphotref
started

The time processing started

step
step_id

Id of the step that was applied

timestamp

When record was last changed

class autowisp.database.data_model.LightCurveStatus(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.LightCurveStatus

Table tracking the status of lightcurves for interrupted steps.

id

A unique identifier for each row.

processing
progress_id

The ID of the LC processing progress which was interrupted

status

The status of the processing (0 = started, >0 = successfully saved progress, negative values indicate various reasons for failure).

timestamp

When record was last changed

class autowisp.database.data_model.MasterFile(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.MasterFile

The table tracking master files generated and used by the pipeline.

enabled

Can this master be used for calibrations?

filename

The full path of the master file.

id

A unique identifier for each row.

master_type
progress_id

The ImageProcessingProgress or LightCurveProcessingProgress that generated this master, if any.

timestamp

When record was last changed

type_id

The type of master file.

use_smallest

Use the master of this type for which this expression evaluated against image header gives the smallest value

class autowisp.database.data_model.MasterType(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.MasterType

The table tracking the types of master files used by the pipeline.

condition_id

The collection of expression involving header keywords that must match between an image and a master for a master to be useable for calibrating that image.

description

A description of the master file type.

id

A unique identifier for each row.

maker_image_split_condition_id

The collection of expression involving header keywords that must match between all images that are combined into a master in addition to the expressions specified by condition_id.

maker_image_type_id

The image type to which the maker step is applied when creating masters of this type.

maker_step_id

The step which produces this type of master frames.

master_files
match_expressions: Mapped[List[ConditionExpression]]
name

The name of the master file type.

split_expressions: Mapped[List[ConditionExpression]]
timestamp

When record was last changed

class autowisp.database.data_model.ObservingSession(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.ObservingSession

The table describing the observing session

camera
camera_id

The id of the camera

end_time_utc

The end time of the observing session in UTC

id

A unique identifier for each row.

images
label

Unique label assigned to the observing session

mount
mount_id

The id of the mount

notes

The notes provided for the observing session

observatory
observatory_id

The id of the observatory

observer
observer_id

The id of the observer

start_time_utc

The start time of the observing session in UTC

target
target_id

The id of the target

telescope
telescope_id

The id of the telescope

timestamp

When record was last changed

class autowisp.database.data_model.Parameter(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.Parameter

Table describing the configuration parameters needed by the pipeline.

description

Description of what the step does.

id

A unique identifier for each row.

name

The name of the step within the pipeline.

steps: Mapped[List[Step]]
timestamp

When record was last changed

class autowisp.database.data_model.ProcessedImages(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.ProcessedImages

The table describing the processed images/channels by each step.

channel

The channel of the image that was processed.

final

Is this the final processing status? The only case where status=1 is not final is for magnitude fitting, where there may be additional iterations needed.

id

A unique identifier for each row.

image
image_id

The image that was processed.

processing
progress_id

The id of the processing progress

status

The status of the processing (0 = started, >0 = successfully saved progress, negative values indicate various reasons for failure). The meaning of negative values is step dependent. For most steps 1 is the final status, but for magnitude fitting the value indicates the iteration.

timestamp

When record was last changed

class autowisp.database.data_model.ProcessingSequence(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.ProcessingSequence

The sequence of steps/image type to be processed by the pipeline.

id

A unique identifier for each row.

image_type
image_type_id

The image type to be processed by the step.

step
step_id

The step to be executed.

timestamp

When record was last changed

class autowisp.database.data_model.Step(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.Step

The table describing the processing steps constituting the pipeline

description

Description of what the step does.

id

A unique identifier for each row.

name

The name of the step within the pipeline.

parameters: Mapped[List[Parameter]]
prerequisites: Mapped[List[StepDependencies]]
timestamp

When record was last changed

class autowisp.database.data_model.StepDependencies(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.StepDependencies

The table describing the prerequisites for a step to run

__str__()[source]

Describe the dependency.

blocked_image_type_id

The image type for which this prerequisite applies.

blocked_imtype
blocked_step
blocked_step_id

The step for which this prerequisite applies.

blocking_image_type_id

The image type for which the prerequisite step must be completed.

blocking_imtype
blocking_step
blocking_step_id

The step which must be completed before the blocked step can begin.

id

A unique identifier for each row.

timestamp

When record was last changed

class autowisp.database.data_model.Target(**kwargs)[source]

Bases: DataModelBase

Inheritance diagram of autowisp.database.data_model.Target

The table dsecribing the target.

dec

The dec of the target

id

A unique identifier for each row.

name

The name of the target

notes

The notes about the target

observing_sessions
ra

The ra of the target

timestamp

When record was last changed

Subpackages

Submodules