pipeline.h.tasks.tsyscal package

Submodules

pipeline.h.tasks.tsyscal.qa module

class pipeline.h.tasks.tsyscal.qa.TsyscalListQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

QA handler for a list containing TsyscalResults.

child_cls

alias of pipeline.h.tasks.tsyscal.resultobjects.TsyscalResults

handle(context, result)

result_cls

alias of collections.abc.Iterable

class pipeline.h.tasks.tsyscal.qa.TsyscalQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

child_cls = None

handle(context, result)

result_cls

alias of pipeline.h.tasks.tsyscal.resultobjects.TsyscalResults

pipeline.h.tasks.tsyscal.renderer module

Created on 9 Sep 2014

@author: sjw

class pipeline.h.tasks.tsyscal.renderer.T2_4MDetailsTsyscalRenderer(uri='tsyscal.mako', description='Calculate Tsys calibration', always_rerender=False)

Bases: pipeline.infrastructure.renderer.basetemplates.T2_4MDetailsDefaultRenderer

update_mako_context(mako_context, pipeline_context, results)

class pipeline.h.tasks.tsyscal.renderer.TsysMapTR(vis, tsys, science)

Bases: tuple

property science

Alias for field number 2

property tsys

Alias for field number 1

property vis

Alias for field number 0

pipeline.h.tasks.tsyscal.renderer.TsysStat

alias of pipeline.h.tasks.tsyscal.renderer.TsysScore

class pipeline.h.tasks.tsyscal.renderer.TsyscalPlotRenderer(context, result, plots)

Bases: pipeline.infrastructure.renderer.basetemplates.JsonPlotRenderer

get_stat(vis, spw, antenna)

get_stat_from_calanalysis(ca_result)

Calculate the median and RMS for a calanalysis result. The argument supplied to this function should be a calanalysis result for ONE spectral window and ONE antenna only!

update_json_dict(d, plot)

Hook function that can be used by extending classes to extract extra parameters from the plot object and insert them into the JSON dictionary for that plot.

pipeline.h.tasks.tsyscal.renderer.create_url_fn(root, plots)

pipeline.h.tasks.tsyscal.resultobjects module

class pipeline.h.tasks.tsyscal.resultobjects.TsyscalResults(final=None, pool=None, preceding=None, unmappedspws=None)

Bases: pipeline.infrastructure.basetask.Results

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.h.tasks.tsyscal.tsyscal module

class pipeline.h.tasks.tsyscal.tsyscal.Tsyscal(inputs)

Bases: pipeline.infrastructure.basetask.StandardTaskTemplate

Inputs

alias of TsyscalInputs

analyse(result)

Determine the best parameters by analysing the given jobs before returning any final jobs to execute.

Parameters

jobs (a list ofJobRequest) – the job requests generated by prepare()

Return type

Result

prepare()

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.h.tasks.tsyscal.tsyscal.TsyscalInputs(context, output_dir=None, vis=None, caltable=None, chantol=None)

Bases: pipeline.infrastructure.vdp.StandardInputs

TsyscalInputs defines the inputs for the Tsyscal pipeline task.

caltable

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])

chantol

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])

to_casa_args()

Express these inputs as a dictionary of CASA arguments. The values in the dictionary are in a format suitable for CASA and can be directly passed to the CASA task.

Return type

a dictionary of string/??? kw/val pairs

Module contents