tsgettoolbox.wdfn_channel_measurements#

tsgettoolbox.wdfn_channel_measurements(*, geometry: Any = None, id: str = None, monitoring_location_id: str = None, field_visit_id: str = None, measurement_number: str = None, time: str = None, channel_name: str = None, channel_flow: str = None, channel_flow_unit: str = None, channel_width: str = None, channel_width_unit: str = None, channel_area: str = None, channel_area_unit: str = None, channel_velocity: str = None, channel_velocity_unit: str = None, channel_location_distance: str = None, channel_location_distance_unit: str = None, channel_stability: str = None, channel_material: str = None, channel_evenness: str = None, horizontal_velocity_description: str = None, vertical_velocity_description: str = None, longitudinal_velocity_description: str = None, measurement_type: str = None, last_modified: str = None, channel_measurement_type: str = None, channel_location_direction: str = None, ts_return_style: Literal['compact', 'full'] = 'compact')#

US:station::E:USGS WDFN Channel measurements as time-series

Channel measurements taken as part of streamflow field measurements.

Parameters:

  • geometry – The geometry parameter is used to filter the results by a specific geographic area. The value should be a GeoJSON geometry object.

  • id – A universally unique identifier (UUID) representing a single version of a record. It is not stable over time. Every time the record is refreshed in our database (which may happen as part of normal operations and does not imply any change to the data itself) a new ID will be generated. To uniquely identify a single observation over time, compare the time and time_series_id fields; each time series will only have a single observation at a given time.

  • monitoring_location_id – A unique identifier representing a single monitoring location. This corresponds to the id field in the monitoring-locations endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).

  • field_visit_id – A universally unique identifier (UUID) for the field visit. Multiple measurements may be made during a single field visit.

  • measurement_number – Measurement number.

  • time –

    The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double- dots at start or end). Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../2018-03-18T12:31:12Z”

    • Duration objects: “P1M” for data from the past month or “PT36H” for the last 36 hours

    Only features that have a time that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.

  • channel_name – The channel name.

  • channel_flow – Channel discharge.

  • channel_flow_unit – The units for channel discharge.

  • channel_width – The channel width.

  • channel_width_unit – The units for channel width.

  • channel_area – The channel area.

  • channel_area_unit – The units for channel area.

  • channel_velocity – The mean channel velocity.

  • channel_velocity_unit – The units for channel velocity.

  • channel_location_distance – The channel location distance.

  • channel_location_distance_unit – The units for channel location distance.

  • channel_stability – The stability of the channel material.

  • channel_material – The channel material.

  • channel_evenness – The channel evenness from bank to bank.

  • horizontal_velocity_description – The horizontal velocity description.

  • vertical_velocity_description – The vertical velocity description.

  • longitudinal_velocity_description – The longitudinal velocity description.

  • measurement_type – The measurement type.

  • last_modified –

    The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end). Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../2018-03-18T12:31:12Z”

    • Duration objects: “P1M” for data from the past month or “PT36H” for the last 36 hours

    Only features that have a last_modified that intersects the value of datetime are selected.

  • channel_measurement_type – The channel measurement type.

  • channel_location_direction – Location of the measurement from the gage.

  • ts_return_style – Return style, either ‘compact’ or ‘full’