Aerosol1D — aerosoltools 0.1.0 documentation

# Aerosol1D

class aerosoltools.aerosol1d.Aerosol1D(dataframe)

  Class for handling 1D aerosol time series measurements.

  This class manages time-indexed aerosol concentration data (e.g., total particle concentration). It provides utilities for resampling, smoothing, marking activity segments, cropping, shifting, summarizing, and plotting data. It is particularly suited for pre- and post-processing of aerosol datasets collected via portable or stationary particle counters.

  ## Parameters

  dataframepandas.DataFrame

    A DataFrame containing time-indexed aerosol data. If the index is not a DatetimeIndex, the first column will be interpreted as timestamps and set as the index automatically. The first data column is assumed to represent total particle concentration.

  ## Notes

  This class is intended for workflows that involve segmenting and analyzing time-resolved total aerosol concentration data. Users should interact primarily through public methods and properties, rather than modifying internal attributes directly.

## Properties

`Aerosol1D.activities` | List of defined activity labels.
`Aerosol1D.activity_periods` | Dictionary of activity names and their associated time periods.
`Aerosol1D.data` | Dataframe with all data, times, and activity columns if marked.
`Aerosol1D.dtype` | Data type description of the measurements.
`Aerosol1D.extra_data` | List of defined activity labels.
`Aerosol1D.instrument` | Instrument used for the measurements.
`Aerosol1D.metadata` | Return overiew of meta data
`Aerosol1D.original_data` | Unmodified original dataset.
`Aerosol1D.serial_number` | Serial number of instrument
`Aerosol1D.time` | Timestamps of the dataset.
`Aerosol1D.total_concentration` | Total concentration measurements.
`Aerosol1D.unit` | Unit of the measurements.

## Methods

`Aerosol1D.copy_self` | Create a deep copy of the current Aerosol1D object.
`Aerosol1D.get_activity_data` | Extract data corresponding to a specified activity.
`Aerosol1D.mark_activities` | Mark activities in the data by adding one boolean column per activity.
`Aerosol1D.plot_total_conc` | Plot the total concentration over time.
`Aerosol1D.summarize` | Summarize total concentration statistics for each defined activity, including 'All data'.
`Aerosol1D.timecrop` | Crop the data to a specified time window.
`Aerosol1D.timerebin` | Resample the data to a new time frequency using an aggregation function.
`Aerosol1D.timeshift` | Shift the time index by a given number of seconds and/or minutes.
`Aerosol1D.timesmooth` | Apply rolling window smoothing to the data.