pipeline.hsd.tasks.importdata package

Submodules

pipeline.hsd.tasks.importdata.importdata module

class pipeline.hsd.tasks.importdata.importdata.HpcSDImportData(inputs)

Bases: pipeline.infrastructure.sessionutils.ParallelTemplate

Inputs

alias of HpcSDImportDataInputs

Task

alias of SDImportData

get_result_for_exception(*args, **kw)

class pipeline.hsd.tasks.importdata.importdata.HpcSDImportDataInputs(context, vis=None, output_dir=None, asis=None, process_caldevice=None, session=None, overwrite=None, nocopy=None, bdfflags=None, save_flagonline=None, lazy=None, with_pointing_correction=None, createmms=None, ocorr_mode=None, parallel=None)

Bases: pipeline.hsd.tasks.importdata.importdata.SDImportDataInputs

property parallel

class pipeline.hsd.tasks.importdata.importdata.SDImportData(inputs)

Bases: pipeline.h.tasks.importdata.importdata.ImportData

Inputs

alias of SDImportDataInputs

prepare(**parameters)

Prepare job requests for execution.

Parameters

parameters – the parameters to pass through to the subclass. Refer to the implementing subclass for specific information on what these parameters are.

Return type

a class implementing Result

class pipeline.hsd.tasks.importdata.importdata.SDImportDataInputs(context=None, vis=None, output_dir=None, asis=None, process_caldevice=None, session=None, overwrite=None, nocopy=None, bdfflags=None, save_flagonline=None, lazy=None, with_pointing_correction=None, createmms=None, ocorr_mode=None)

Bases: pipeline.h.tasks.importdata.importdata.ImportDataInputs

asis

VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.

On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:

1. If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.

A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.

A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.

Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,

solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])

createmms

VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.

On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:

1. If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.

A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.

A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.

Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,

solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])

ocorr_mode

VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.

On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:

1. If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.

A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.

A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.

Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,

solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])

with_pointing_correction

VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.

On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:

1. If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.

A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.

A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.

Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,

solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])

class pipeline.hsd.tasks.importdata.importdata.SDImportDataResults(mses=None, reduction_group_list=None, datatable_prefix=None, setjy_results=None, org_directions=None)

Bases: pipeline.infrastructure.basetask.Results

SDImportDataResults is an equivalent class with ImportDataResults. Purpose of SDImportDataResults is to replace QA scoring associated with ImportDataResults with single dish specific QA scoring, which is associated with this class.

ImportDataResults holds the results of the ImportData task. It contains the resulting MeasurementSet domain objects and optionally the additional SetJy results generated from flux entries in Source.xml.

merge_with_context(context)

Merge these results with the given context.

This method will be called during the execution of accept(). For calibration tasks, a typical implementation will register caltables with the pipeline callibrary.

At this point the result is deemed safe to merge, so no further checks on the context need be performed.

Parameters

context (Context) – the target Context

pipeline.hsd.tasks.importdata.inspection module

class pipeline.hsd.tasks.importdata.inspection.SDInspection(context, table_name, ms=None)

Bases: object

execute(dry_run=True)

pipeline.hsd.tasks.importdata.inspection.match_field_name(name1, name2)

Returns True if two (field) names match search patterns, i.e., either (name2 == name1 + pattern) or (name1 == name2 + pattern). Otherwise, returns False. Note the method returns False for the exact match, i.e., name1 == name2.

pipeline.hsd.tasks.importdata.qa module

class pipeline.hsd.tasks.importdata.qa.SDImportDataListQAHandler

Bases: pipeline.h.tasks.importdata.qa.ImportDataListQAHandler, pipeline.infrastructure.pipelineqa.QAPlugin

child_cls

alias of pipeline.hsd.tasks.importdata.importdata.SDImportDataResults

class pipeline.hsd.tasks.importdata.qa.SDImportDataQAHandler

Bases: pipeline.h.tasks.importdata.qa.ImportDataQAHandler, pipeline.infrastructure.pipelineqa.QAPlugin

child_cls = None

generating_task

alias of pipeline.hsd.tasks.importdata.importdata.SDImportData

result_cls

alias of pipeline.hsd.tasks.importdata.importdata.SDImportDataResults

pipeline.hsd.tasks.importdata.reader module

class pipeline.hsd.tasks.importdata.reader.MetaDataReader(context, ms, table_name)

Bases: object

detect_target_data_desc()

detect_target_spw()

execute(dry_run=True)

generate_flagcmd()

generate_flagdict_for_invalid_pointing_data()

generate_flagdict_for_uniform_rms()

get_datatable()

get_reference_direction(source_name, ephem_table, is_known_eph_obj, mepoch, mposition, outframe)

property name

register_invalid_pointing_data(antenna_id, row)

pipeline.hsd.tasks.importdata.reader.get_state_id(ms, spw, intent)

pipeline.hsd.tasks.importdata.reader.get_value_in_deg(quantity)

pipeline.hsd.tasks.importdata.reader.initialize_template(flagtemplate)

pipeline.hsd.tasks.importdata.reader.merge_timerange(timerange_list)

pipeline.hsd.tasks.importdata.reader.set_nominal_direction(ant, srctype, az, el, ra, dec, shift_ra, shift_dec, offset_ra, offset_dec)

pipeline.hsd.tasks.importdata.reader.write_flagcmd(flagtemplate, antenna_id, timerange_list, reason='')

pipeline.hsd.tasks.importdata.renderer module

pipeline.hsd.tasks.importdata.renderer.DeductionGroupTR

alias of pipeline.hsd.tasks.importdata.renderer.ReductionGroupTR

class pipeline.hsd.tasks.importdata.renderer.T2_4MDetailsSingleDishImportDataRenderer(uri='hsd_importdata.mako', description='Register measurement sets with the pipeline', always_rerender=False)

Bases: pipeline.h.tasks.importdata.renderer.T2_4MDetailsImportDataRenderer

update_mako_context(mako_context, pipeline_context, result)

Module contents