pipeline.hif.tasks.bandpass package

Submodules

pipeline.hif.tasks.bandpass.adapters module

The adapters module contains classes that adapt Heuristics in the pipeline.heuristics package, allowing them to be called directly with low-level objects from the pipeline domain.

Heuristics in the pipeline.heuristics package have simple interfaces; to maximize their ease of use, their interfaces accept only Python and NumPy primitives.

As the pipeline deals with complex lower-level objects and structures, we need a way to convert from these structures to the simple primitives demanded by the Heuristics. The classes in this module encapsulate that logic, converting objects or reading calibration tables as necessary and extracting the information needed by the wrapped Heuristic.

class pipeline.hif.tasks.bandpass.adapters.DegAmpAdapter(heuristic)

Bases: pipeline.hif.tasks.bandpass.adapters.PolynomialHeuristicAdapter

class pipeline.hif.tasks.bandpass.adapters.DegPhaseAdapter(heuristic)

Bases: pipeline.hif.tasks.bandpass.adapters.PolynomialHeuristicAdapter

class pipeline.hif.tasks.bandpass.adapters.PhaseUpSolIntAdapter(heuristic)

Bases: pipeline.infrastructure.adapters.Adapter

PhaseUpSolIntAdapter adapts the PhaseUpSolInt heuristic, taking in a MeasurementSet and intent and passing the median integration time for observations with that intent through to the science heuristic.

calculate(ms, intent)

Extract the integration time for observations with the given intent from the measurement set and pass it to the wrapped heuristic, returning the result.

Parameters

• ms (MeasurementSet) – the MeasurementSet to examine

• intent (string) – the intent for which to find the integration time

class pipeline.hif.tasks.bandpass.adapters.PolynomialHeuristicAdapter(heuristic)

Bases: pipeline.infrastructure.adapters.Adapter

PolynomialHeuristicAdapter converts from the pipeline interface for a polynomial order heuristic, the string name of a caltable, to the data types needed by the heuristic itself, which are numerical data arrays.

calculate(ms, caltable, spw)

Make a calculation based on the given parameters.

This is an abstract method and must be implemented by all Heuristic subclasses.

Note

The signature and return types of calculate() are intended to be implementation specific. Refer to the documentation of the implementing class for the appropriate signature.

read_caltable(ms, caltable, spw)

Method to read channel calibration table and return it as a Python array.

Keyword arguments: table – The name of the calibration table spw – The SpW of interest. msobject – MeasurementSet domain object from which the calibration

was calculated.

Returns: data - ‘view’ of calibration gains in numpy complex array[antenna,channel] flag - flags associated with data array bool[antenna,channel]

pipeline.hif.tasks.bandpass.bandpassmode module

class pipeline.hif.tasks.bandpass.bandpassmode.BandpassMode(inputs)

Bases: pipeline.infrastructure.basetask.ModeTask

Inputs

alias of BandpassModeInputs

class pipeline.hif.tasks.bandpass.bandpassmode.BandpassModeInputs(context, mode=None, **parameters)

Bases: pipeline.infrastructure.vdp.ModeInputs

pipeline.hif.tasks.bandpass.bandpassworker module

class pipeline.hif.tasks.bandpass.bandpassworker.BandpassWorker(inputs)

Bases: pipeline.infrastructure.basetask.StandardTaskTemplate

BandpassWorker performs a simple bandpass calibration exactly as specified by the inputs, with no analysis or parameter refinement.

As this task has no analysis, it is not expected to be used in an interactive session. The expected use-case for this task is as a worker task for higher-level tasks.

Inputs

alias of BandpassWorkerInputs

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.hif.tasks.bandpass.bandpassworker.BandpassWorkerInputs(context, output_dir=None, vis=None, caltable=None, field=None, spw=None, antenna=None, intent=None, solint=None, combine=None, refant=None, minblperant=None, minsnr=None, solnorm=None, bandtype=None, fillgaps=None, degamp=None, degphase=None, visnorm=None, maskcenter=None, maskedge=None, append=None, scan=None, opacity=None, parang=None)

Bases: pipeline.hif.tasks.bandpass.common.VdpCommonBandpassInputs

BandpassInputs defines the inputs required by the Bandpass task.

pipeline.hif.tasks.bandpass.channelbandpass module

class pipeline.hif.tasks.bandpass.channelbandpass.ChannelBandpass(inputs)

Bases: pipeline.hif.tasks.bandpass.bandpassworker.BandpassWorker

Inputs

alias of ChannelBandpassInputs

class pipeline.hif.tasks.bandpass.channelbandpass.ChannelBandpassInputs(context, output_dir=None, vis=None, caltable=None, field=None, spw=None, antenna=None, intent=None, solint=None, combine=None, refant=None, minblperant=None, minsnr=None, solnorm=None, fillgaps=None, append=None, scan=None, opacity=None, parang=None)

Bases: pipeline.hif.tasks.bandpass.common.VdpCommonBandpassInputs

property bandtype

minsnr

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

pipeline.hif.tasks.bandpass.common module

class pipeline.hif.tasks.bandpass.common.BandpassResults(final: List[pipeline.infrastructure.callibrary.CalApplication] = None, pool: List[pipeline.infrastructure.callibrary.CalApplication] = None, preceding: List[pipeline.infrastructure.basetask.Results] = None, applies_adopted: bool = False, unregister_existing: bool = False)

Bases: pipeline.infrastructure.basetask.Results

BandpassResults is the results class common to all pipeline bandpass calibration tasks.

merge_with_context(context: pipeline.infrastructure.launcher.Context)

See :method:`~pipeline.api.Results.merge_with_context`

class pipeline.hif.tasks.bandpass.common.VdpCommonBandpassInputs(context, output_dir=None, vis=None, intent=None, field=None, spw=None, refant=None, antenna=None, minblperant=None, opacity=None, selectdata=None, uvrange=None)

Bases: pipeline.hif.tasks.common.commoncalinputs.VdpCommonCalibrationInputs

CommonBandpassInputs is the base class for defines inputs that are common to all pipeline bandpass calibration tasks.

CommonBandpassInputs should be considered an abstract class. Refer to the specializations that inherit from CommonBandpassInputs for concrete implementations.

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

combine

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

intent

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

solint

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

solnorm

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

pipeline.hif.tasks.bandpass.phcorbandpass module

class pipeline.hif.tasks.bandpass.phcorbandpass.PhcorBandpass(inputs)

Bases: pipeline.hif.tasks.bandpass.bandpassworker.BandpassWorker

Inputs

alias of PhcorBandpassInputs

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.hif.tasks.bandpass.phcorbandpass.PhcorBandpassInputs(context, mode=None, phaseup=None, phaseupbw=None, phaseupsolint=None, solint=None, **parameters)

Bases: pipeline.hif.tasks.bandpass.bandpassmode.BandpassModeInputs

phaseup

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

phaseupbw

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

phaseupsolint

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

solint

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

pipeline.hif.tasks.bandpass.qa module

class pipeline.hif.tasks.bandpass.qa.BandpassListQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

QA handler for a list containing BandpassResults.

child_cls

alias of pipeline.hif.tasks.bandpass.common.BandpassResults

handle(context, result)

result_cls

alias of collections.abc.Iterable

class pipeline.hif.tasks.bandpass.qa.BandpassQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

QA handler for an uncontained BandpassResult.

child_cls = None

handle(context, result)

result_cls

alias of pipeline.hif.tasks.bandpass.common.BandpassResults

class pipeline.hif.tasks.bandpass.qa.BandpassQAPool(rawdata, caltable)

Bases: pipeline.infrastructure.pipelineqa.QAScorePool

score_types = {'AMPLITUDE_SCORE_SNR': 'amplitude SNR', 'PHASE_SCORE_DD': 'phase derivative'}

short_msg = {'AMPLITUDE_SCORE_SNR': 'Amp SNR', 'PHASE_SCORE_DD': 'Phase derivative'}

update_scores(ms)

MeasurementSet is needed to convert from integer identifier stored in QA dictionary to the antenna, spw and pol it represents.

pipeline.hif.tasks.bandpass.renderer module

Created on 11 Sep 2014

@author: sjw

class pipeline.hif.tasks.bandpass.renderer.AdoptedTR(vis, gaintable)

Bases: tuple

property gaintable

Alias for field number 1

property vis

Alias for field number 0

class pipeline.hif.tasks.bandpass.renderer.BandpassAmpVsFreqPlotRenderer(context, results, plots)

Bases: pipeline.hif.tasks.bandpass.renderer.BaseBandpassPlotRenderer

class pipeline.hif.tasks.bandpass.renderer.BandpassApplication(ms, bandtype, solint, intent, spw, gaintable)

Bases: tuple

property bandtype

Alias for field number 1

property gaintable

Alias for field number 5

property intent

Alias for field number 3

property ms

Alias for field number 0

property solint

Alias for field number 2

property spw

Alias for field number 4

class pipeline.hif.tasks.bandpass.renderer.BandpassPhaseVsFreqPlotRenderer(context, results, plots)

Bases: pipeline.hif.tasks.bandpass.renderer.BaseBandpassPlotRenderer

class pipeline.hif.tasks.bandpass.renderer.BaseBandpassPlotRenderer(uri, context, results, plots, title, outfile, score_types)

Bases: pipeline.infrastructure.renderer.basetemplates.JsonPlotRenderer

update_json_dict(json_dict, 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.

class pipeline.hif.tasks.bandpass.renderer.PhaseupApplication(ms, calmode, solint, minblperant, minsnr, flagged, phaseupbw)

Bases: tuple

property calmode

Alias for field number 1

property flagged

Alias for field number 5

property minblperant

Alias for field number 3

property minsnr

Alias for field number 4

property ms

Alias for field number 0

property phaseupbw

Alias for field number 6

property solint

Alias for field number 2

class pipeline.hif.tasks.bandpass.renderer.T2_4MDetailsBandpassRenderer(uri='bandpass.mako', description='Bandpass calibration', always_rerender=False)

Bases: pipeline.infrastructure.renderer.basetemplates.T2_4MDetailsDefaultRenderer

T2_4MDetailsBandpassRenderer generates the detailed T2_4M-level plots and output specific to the bandpass calibration task.

get_bandpass_table(context, result, ms)

get_phaseup_applications(context, result, ms)

update_mako_context(ctx, context, results)

pipeline.hif.tasks.bandpass.renderer.make_adopted_table(context, results)

Module contents