mao_merge_45m.accelerometer_csv module#

class Accelerometer(accelerometer_ch1: Union[CH1, Any], accelerometer_ch2: Union[CH2, Any], accelerometer_ch3: Union[CH3, Any], accelerometer_ch4: Union[CH4, Any], accelerometer_ch5: Union[CH5, Any], accelerometer_ch6: Union[CH6, Any], accelerometer_ch7: Union[CH7, Any], accelerometer_ch8: Union[CH8, Any])[source]#

Bases: AsDataset

Specification of accelerometer logs in xarray.

Parameters

  • accelerometer_ch1 (Union[CH1, Any]) –

  • accelerometer_ch2 (Union[CH2, Any]) –

  • accelerometer_ch3 (Union[CH3, Any]) –

  • accelerometer_ch4 (Union[CH4, Any]) –

  • accelerometer_ch5 (Union[CH5, Any]) –

  • accelerometer_ch6 (Union[CH6, Any]) –

  • accelerometer_ch7 (Union[CH7, Any]) –

  • accelerometer_ch8 (Union[CH8, Any]) –

Return type

None

accelerometer_ch1: Union[mao_merge_45m.accelerometer_csv.CH1, Any]#

Data of CH1.

accelerometer_ch2: Union[mao_merge_45m.accelerometer_csv.CH2, Any]#

Data of CH2.

accelerometer_ch3: Union[mao_merge_45m.accelerometer_csv.CH3, Any]#

Data of CH3.

accelerometer_ch4: Union[mao_merge_45m.accelerometer_csv.CH4, Any]#

Data of CH4.

accelerometer_ch5: Union[mao_merge_45m.accelerometer_csv.CH5, Any]#

Data of CH5.

accelerometer_ch6: Union[mao_merge_45m.accelerometer_csv.CH6, Any]#

Data of CH6.

accelerometer_ch7: Union[mao_merge_45m.accelerometer_csv.CH7, Any]#

Data of CH7.

accelerometer_ch8: Union[mao_merge_45m.accelerometer_csv.CH8, Any]#

Data of CH8.

class CH1(data: Annotated[Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float], <Role.DATA: 'data'>], long_name: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'Accelerometer CH1', units: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'mV')[source]#

Bases: object

Parameters

  • data (Union[Labeled[Literal['time']], Collection[float], float]) –

  • long_name (str) –

  • units (str) –

Return type

None

data: Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float]#
long_name: str = 'Accelerometer CH1'#
units: str = 'mV'#
class CH2(data: Annotated[Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float], <Role.DATA: 'data'>], long_name: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'Accelerometer CH2', units: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'mV')[source]#

Bases: object

Parameters

  • data (Union[Labeled[Literal['time']], Collection[float], float]) –

  • long_name (str) –

  • units (str) –

Return type

None

data: Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float]#
long_name: str = 'Accelerometer CH2'#
units: str = 'mV'#
class CH3(data: Annotated[Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float], <Role.DATA: 'data'>], long_name: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'Accelerometer CH3', units: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'mV')[source]#

Bases: object

Parameters

  • data (Union[Labeled[Literal['time']], Collection[float], float]) –

  • long_name (str) –

  • units (str) –

Return type

None

data: Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float]#
long_name: str = 'Accelerometer CH3'#
units: str = 'mV'#
class CH4(data: Annotated[Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float], <Role.DATA: 'data'>], long_name: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'Accelerometer CH4', units: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'mV')[source]#

Bases: object

Parameters

  • data (Union[Labeled[Literal['time']], Collection[float], float]) –

  • long_name (str) –

  • units (str) –

Return type

None

data: Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float]#
long_name: str = 'Accelerometer CH4'#
units: str = 'mV'#
class CH5(data: Annotated[Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float], <Role.DATA: 'data'>], long_name: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'Accelerometer CH5', units: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'mV')[source]#

Bases: object

Parameters

  • data (Union[Labeled[Literal['time']], Collection[float], float]) –

  • long_name (str) –

  • units (str) –

Return type

None

data: Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float]#
long_name: str = 'Accelerometer CH5'#
units: str = 'mV'#
class CH6(data: Annotated[Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float], <Role.DATA: 'data'>], long_name: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'Accelerometer CH6', units: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'mV')[source]#

Bases: object

Parameters

  • data (Union[Labeled[Literal['time']], Collection[float], float]) –

  • long_name (str) –

  • units (str) –

Return type

None

data: Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float]#
long_name: str = 'Accelerometer CH6'#
units: str = 'mV'#
class CH7(data: Annotated[Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float], <Role.DATA: 'data'>], long_name: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'Accelerometer CH7', units: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'degC')[source]#

Bases: object

Parameters

  • data (Union[Labeled[Literal['time']], Collection[float], float]) –

  • long_name (str) –

  • units (str) –

Return type

None

data: Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float]#
long_name: str = 'Accelerometer CH7'#
units: str = 'degC'#
class CH8(data: Annotated[Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float], <Role.DATA: 'data'>], long_name: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'Accelerometer CH8', units: typing.Annotated[str, <Role.ATTR: 'attr'>] = 'degC')[source]#

Bases: object

Parameters

  • data (Union[Labeled[Literal['time']], Collection[float], float]) –

  • long_name (str) –

  • units (str) –

Return type

None

data: Union[xarray_dataclasses.typing.Labeled[Literal['time']], Collection[float], float]#
long_name: str = 'Accelerometer CH8'#
units: str = 'degC'#
assert_units(path: Path) → None[source]#

Check if units of an accelerometer log is valid.

Parameters

path (Path) –

Return type

None

convert(path_log: Union[Sequence[Path], Path], path_zarr: Optional[Path] = None, *, length_per_chunk: int = 1000000, overwrite: bool = False, progress: bool = False) → Path[source]#

Convert raw accelerometer log(s) to a formatted Zarr file.

This function will make a one-dimensional accelerometer outputs with time metadata derived from the raw CSV file(s).

Parameters

  • path_log (Union[Sequence[Path], Path]) – Path(s) of the raw accelerometer CSV file(s).

  • path_zarr (Optional[Path]) – Path of the formatted Zarr file (optional).

  • length_per_chunk (int) – Length per chunk in the Zarr file.

  • overwrite (bool) – Whether to overwrite the formatted Zarr file if exists.

  • progress (bool) – Whether to show a progress bar.

Returns

Path of the formatted Zarr file.

Raises

FileExistsError – Raised if the formatted Zarr file exists and overwriting is not allowed (default).

Return type

Path

Notes

The timezone of the Zarr file is not JST but UTC.

read_csv(path: Path) → DataFrame[source]#

Custom read_csv function dedicated to accelerometer logs.

Parameters

path (Path) –

Return type

DataFrame

previous

mao_merge_45m.accelerometer module

next

mao_merge_45m.antenna module