API Reference

AbstractCoordinateSystem

Base abstract type for all coordinate system implementations.

AbstractCoordinateVector

Base abstract type to represent coordinates in a coordinate systems.

A variable v of a type derived from AbstractDataVariable should at least implement:

• Base.parent(v): the parent array of the variable

Optional:

• times(v): the timestamps of the variable
• units(v): the units of the variable
• meta(v): the metadata of the variable
• name(v): the name of the variable

DataSet <: AbstractDataSet

A concrete dataset with a name, data (parameters), and metadata.

Construct a DataSet from a name and data, with optional metadata.

DataSet(ld::LDataSet; kwargs...)

Create a concrete DataSet from a Dataset template with specified data.

See also: LDataSet

Instrument <: AbstractInstrument

Fields

• name: The name of the instrument
• metadata: Additional metadata
• datasets: Collection of datasets

Construct an Instrument from a dictionary.

keyword-based constructor

LDataSet <: AbstractDataSet

A template for generating datasets with parameterized naming patterns.

Fields

• format: Format string pattern for the dataset name
• data: Dictionary of variable patterns
• metadata: Additional metadata

Examples

using SPEDAS.MMS

# Access FPI dataset specification
lds = mms.datasets.fpi_moms

# Create a concrete dataset with specific parameters
ds = DataSet(lds; probe=1, data_rate="fast", data_type="des")

The format string and variable patterns use placeholders like {probe}, {data_rate}, which are replaced with actual values when creating a concrete DataSet.

Construct a LDataSet from a dictionary.

Project <: AbstractProject

A representation of a project or mission containing instruments and datasets.

Fields

• name: The name of the project
• metadata: Additional metadata
• instruments: Collection of instruments
• datasets: Collection of datasets

keyword-based constructor

abbr(p)

Get the abbreviation (abbr) of p.

getcsys(x)

Get the coordinate system of x.

If x is a instance of AbstractCoordinateSystem, return x itself. If x is a type of AbstractCoordinateSystem, return an instance of the coordinate system, i.e. x().

This is a generic function, packages should extend it for their own types.

Create a new product with the composed function

_getfield(v, name, default)

Return the field from a composite v for the given name, or the given default if no field is present.

See also: getfield.

Check if a string is in Day of Year format (YYYY-DDD).