ska_oso_pdm.schemas.common.target

The schemas.common.target defines Marshmallow schema that map the target pointing section of an SKA scheduling block to/from JSON.

class CoordinatesSchema(*args: Any, **kwargs: Any)

Marshmallow schema for handling polymorphic coordinates classes.

class CrossScanParametersSchema(*args: Any, **kwargs: Any)

Marshmallow schema for converting a CrossScanParameters to/from JSON

make_crossscanparameters(data, **_)

Convert parsed JSON back into a CrossScanParameters object

Parameters:

• data – dict containing parsed JSON values

• _ – kwargs passed by Marshmallow

Returns:

CrossScanParameters instance populated to match JSON

class EquatorialCoordinatesSchema(*args: Any, **kwargs: Any)

Convert an EquatorialCoordinates to/from JSON.

make_equatorialcoordinates(data, **_)

Convert parsed JSON back into an EquatorialCoordinates object.

Parameters:

• data – dict containing parsed JSON values

• _ – kwargs passed by Marshmallow

Returns:

EquatorialCoordinates instance populated to match JSON

reference_frame

alias of EquatorialCoordinatesReferenceFrame

class FivePointParametersSchema(*args: Any, **kwargs: Any)

Marshmallow schema for converting a FivePointParameters to/from JSON

make_fivepointparameters(data, **_)

Convert parsed JSON back into a FivePointParameters object

Parameters:

• data – dict containing parsed JSON values

• _ – kwargs passed by Marshmallow

Returns:

FivePointParameters instance populated to match JSON

class HorizontalCoordinatesSchema(*args: Any, **kwargs: Any)

Marshmallow schema to convert a HorizontalCoordinates to/from JSON.

make_horizontalcoordinates(data, **_)

Convert parsed JSON back into a HorizontalCoordinates object.

Parameters:

• data – dict containing parsed JSON values

• _ – kwargs passed by Marshmallow

Returns:

HorizontalCoordinates instance populated to match JSON

reference_frame

alias of HorizontalCoordinatesReferenceFrame

class JsonEquatorialCoordinate(kind, ra, dec, reference_frame, unit)

dec

Alias for field number 2

kind

Alias for field number 0

ra

Alias for field number 1

reference_frame

Alias for field number 3

unit

Alias for field number 4

class JsonHorizontalCoordinate(kind, az, el, reference_frame, unit)

az

Alias for field number 1

el

Alias for field number 2

kind

Alias for field number 0

reference_frame

Alias for field number 3

unit

Alias for field number 4

class PointingPatternParametersSchema(*args: Any, **kwargs: Any)

Marshmallow schema for handling polymorphic pointing pattern parameter classes.

class PointingPatternSchema(*args: Any, **kwargs: Any)

Marshallow schema for converts a PointingPattern to/from JSON.

make_pointingpattern(data, **_)

Convert parsed JSON back into a PointingPattern object.

Parameters:

• data – dict containing parsed JSON values

• _ – kwargs passed by Marshmallow

Returns:

PointingPattern instance populated to match JSON

class RasterParametersSchema(*args: Any, **kwargs: Any)

Marshmallow schema for converting a RasterParameters to/from JSON

make_rasterparameters(data, **_)

Convert parsed JSON back into a RasterParameters object

Parameters:

• data – dict containing parsed JSON values

• _ – kwargs passed by Marshmallow

Returns:

RasterParameters instance populated to match JSON

class SinglePointParametersSchema(*args: Any, **kwargs: Any)

Marshmallow schema for converting a SinglePointParameters to/from JSON

make_singlepointparameters(data, **_)

Convert parsed JSON back into a SinglePointParameters object

Parameters:

• data – dict containing parsed JSON values

• _ – kwargs passed by Marshmallow

Returns:

SinglePointParameters instance populated to match JSON

class SolarSystemObjectSchema(*args: Any, **kwargs: Any)

Schema for marshalling SolarSystemObject coordinates to/from JSON

create_instance(data, **_)

Convert parsed JSON back into a SolarSystemObject

Parameters:

• data – dict containing parsed JSON values

• _ – kwargs passed by Marshmallow

Returns:

instance populated to match JSON

name

alias of SolarSystemObjectName

class StarRasterParametersSchema(*args: Any, **kwargs: Any)

Marshmallow schema for converting a StarRasterParameters to/from JSON

make_starrasterparameters(data, **_)

Convert parsed JSON back into a StarRasterParameters object

Parameters:

• data – dict containing parsed JSON values

• _ – kwargs passed by Marshmallow

Returns:

StarRasterParameters instance populated to match JSON

class TargetSchema(*args: Any, **kwargs: Any)

Marshmallow class to convert Target to/from JSON.

make_target(data, **_)

Convert parsed JSON back into a Target object

Parameters:

• data – dict containing parsed JSON values

• _ – kwargs passed by Marshmallow

Returns:

Target instance populated to match JSON

pointing_pattern

alias of PointingPatternSchema

reference_coordinate

alias of CoordinatesSchema