gwcs.coordinate_frames.WorldAxisObjectClass

class gwcs.coordinate_frames.WorldAxisObjectClass(class_object: type | str, arguments: tuple[Any, ...], keyword_arguments: dict[str, Any])

Bases: NamedTuple

A tuple to document the individual elements of the world_axis_object_classes of the WCS API.

Notes

  • world_axis_object_classes will return a dictionary with the key being

    the name from world_axis_object_components and the value being an instance of this class.

  • To stay consistent with the APE 14 API, users should not access the elements

    of this tuple via their names, but instead should access them via their position in the tuple.

Variables:
  • class_object – The High-Level Object class for the axis or a string that is the fully qualified name of the class.

  • arguments – The positional arguments to be passed to the class when instantiating an object of this class. Note if world_axis_object_components specifies that the world coordinates should be passed as a positional argument, then this tuple will include None as a place holder for each of the world coordinates.

  • keyword_arguments – The keyword arguments to be passed to the class when instantiating an object of this class.

Parameters:

Create new instance of WorldAxisObjectClass(class_object, arguments, keyword_arguments)

Parameters:

Attributes

arguments

Alias for field number 1

class_object

Alias for field number 0

keyword_arguments

Alias for field number 2

WorldAxisObjectClass.arguments: tuple[Any, ...]

Alias for field number 1

WorldAxisObjectClass.class_object: type | str

Alias for field number 0

WorldAxisObjectClass.keyword_arguments: dict[str, Any]

Alias for field number 2

Methods

count(value, /)

Return number of occurrences of value.

index(value[, start, stop])

Return first index of value.

WorldAxisObjectClass.count(value, /)

Return number of occurrences of value.

WorldAxisObjectClass.index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.