Schema

Terms and Definitions

The metadata fully describes the five key components of a DAS data collection system: (1) interrogator, (2) data acquisition, (3) channels, (4) cable, and (5) fiber. The metadata schema is hierarchical based, with a parent overview metadata block describing the experiment, and two main child branches describing the instrument (i.e., interrogator, photonics setup, acquisition parameters) and the sensor locations (i.e., cable installation and fiber properties). The simplest example is one fiber within one cable connected to one interrogator. The suggested metadata structure allows for much more complex installations with multiple fibers, cables, and interrogators deployed with different acquisition parameters. The metadata schema is designed to be independent of the time-series data so that corrections and updates can be applied to the metadata, without having to manipulate large volumes of time-series data.

Each metadata block consists of required and optional attributes. Required metadata is information that is considered essential to enable re-use of the data. This information makes the data self-describing and no further information required from the provider to work with the data. Optional metadata is information that could be useful in interpreting the measured signal but is not essential.

Structure

The proposed metadata is divided into six major blocks: overview, interrogator, acquisition, channel group (and individual channel), cable, and fiber.

Conceptual model of the metadata schema

Overview metadata

The Overview metadata gives a high-level overview of the DAS deployment and describes the geographic location of the installation, dates of the project, and information on the data provider.

Type: object

Overview metadata

Property

Type

Required

Description

version

None

Required

Metadata schema version

network_code

string

Required

Unique FDSN network code for the More

location

string

Required

Name of the geographic location More

country

string

Required

Country where the installation i More

principal_investigator

array

Required

Principal investigator(s) for th More

point_of_contact

string

Required

Point of contact for the metadat More

point_of_contact_email

string

Required

Email address of point of contac More

point_of_contact_address

string

Required

Physical address and institution More

start_date

string

Required

Start date of data collection at More

end_date

string

Required

End date of data collection at t More

funding_agency

string

Required

Name(s) of agency that funded th More

project_number

string

Required

Funding project number

digital_object_identifier

string

Required

Digital object identifier (DOI) More

purpose_of_data_collection

string

Required

Brief explanation of the purpose More

comment

string

Required

Additional comments

interrogators

array

Required

Interrogators

cables

array

Required

Cables


version

Metadata schema version. This identifies which version of the metadata schema that this document conforms to.

Type:

None

Required:

Required

Possible Values:

2.0


network_code

Unique FDSN network code for the installation, following FDSN Source Identifier specification

Type:

string

Required:

Required

Possible Values:

^[A-Z0-9]+$

Examples:

"3U2023"


location

Name of the geographic location of the installation.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"Brady's Hot Springs, Nevada"


country

Country where the installation is located. Use ISO 3166-1 alpha-3 three-letter country code.

Type:

string

Required:

Required

Possible Values:

Length: 3 <= string <= 3

Examples:

"USA"


principal_investigator

Principal investigator(s) for the installation.

Type:

array

Required:

Required

Possible Values:

principal_investigator_fields


point_of_contact

Point of contact for the metadata.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"Dr. Jean Grey"


point_of_contact_email

Email address of point of contact.

Type:

string

Required:

Required

Possible Values:

Format: email

Examples:

"jean.gray@xavier-institute.com"


point_of_contact_address

Physical address and institution of point of contact.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"University of Wisconsin"


start_date

Start date of data collection at the installation in Coordinated Universal Time (UTC).

Type:

string

Required:

Required

Possible Values:

Format: date

Examples:

"2016-03-11"


end_date

End date of data collection at the installation in UTC. If the installation end date is unknown this field should be omitted and updated when it is known.

Type:

string

Required:

Required

Possible Values:

Format: date

Examples:

"2016-03-26"


funding_agency

Name(s) of agency that funded the experiment.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"U.S. DOE Geothermal Technology Office"


project_number

Funding project number. Should be supplied if a number has been assigned by funding agency(s).

Type:

string

Required:

Required

Possible Values:

string

Examples:

"DOE CN: EE0006760"


digital_object_identifier

Digital object identifier (DOI) that uniquely identifies the metadata; this identifier may only become available following archiving.

Type:

string

Required:

Required

Possible Values:

Format: uri

Examples:

"https://doi.org/10.15121/1778858", "doi:10.5880/GFZ.2.2.2023.001"


purpose_of_data_collection

Brief explanation of the purpose of experiment.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"Monitor geothermal field"


comment

Additional comments.

Type:

string

Required:

Required

Possible Values:

string


interrogators

Interrogators. Multiple interrogators can be documented.

Type:

array

Required:

Required

Possible Values:

interrogator


cables

Cables. Multiple cables can be documented.

Type:

array

Required:

Required

Possible Values:

cable


Principal investigator metadata

The Principal Investigator metadata contains information about the principal investigator for the installation.

Type: object

Principal investigator metadata

Property

Type

Required

Description

name

string

Required

Name of principal investigator f More

email

string

Required

Email address of principal inves More

address

string

Required

Physical address and institution More


principal_investigator_fields > name

Name of principal investigator for the installation.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"Professor Xavier"


principal_investigator_fields > email

Email address of principal investigator.

Type:

string

Required:

Required

Possible Values:

Format: email

Examples:

"professorx@xavier-institute.com"


principal_investigator_fields > address

Physical address and institution of principal investigator.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"University of Wisconsin"


Interrogator metadata

The Interrogator metadata contains information about the interrogator unit used for the data collection. More than one interrogator may be operating during an experiment, therefore each unit is given a unique identifier and described in individual Interrogator metadata blocks.

Type: object

Interrogator metadata

Property

Type

Required

Description

interrogator_id

string

Required

Unique identifier of the interro More

manufacturer

string

Required

Manufacturer name of the interro More

model

string

Required

Model number of the interrogator

serial_number

string

Required

Serial number of the interrogato More

firmware_version

string

Required

Firmware version of the software More

comment

string

Required

Additional comments

acquisitions

array

Required

Acquisitions


interrogator > interrogator_id

Unique identifier of the interrogator unit used in the experiment, assigned by data provider. Identifier should have the maximum of eight alphanumeric characters with no special characters (e.g., underscores, period, and dash).

Type:

string

Required:

Required

Possible Values:

dasid

Examples:

"IU001"


interrogator > manufacturer

Manufacturer name of the interrogator.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"Silixa"


interrogator > model

Model number of the interrogator.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"iDAS"


interrogator > serial_number

Serial number of the interrogator.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"12345"


interrogator > firmware_version

Firmware version of the software used within the interrogator.

Type:

string

Required:

Required

Possible Values:

string


interrogator > comment

Additional comments.

Type:

string

Required:

Required

Possible Values:

string


interrogator > acquisitions

One or more acquisitions with this interrogator.

Type:

array

Required:

Required

Possible Values:

acquisition


Acquisition metadata

The Acquisition metadata describes the acquisition parameters set by the user on a particular interrogator. While different interrogator vendors may implement various photonics design and algorithms which are not easily translatable across interrogators, the Acquisition metadata intends to capture the critical acquisition attributes that are commonly required to analyze and interpret the output time series or matrices. These attributes are carefully defined to be standardized across all interrogator systems.

Type: object

Acquisition metadata

Property

Type

Required

Description

acquisition_id

string

Required

Unique identifier of the data ac More

acquisition_start_time

string

Required

Start time of this data acquisit More

acquisition_end_time

string

Required

End time of this data acquisitio More

acquisition_sample_rate

number

Required

The rate at which the interrogat More

acquisition_sample_rate_unit

string

Required

Unit of acquisition sample rate

gauge_length

number

Required

The averaging length along the f More

gauge_length_unit

string

Required

Unit of gauge length

unit_of_measure

None

Required

Unit of measure of archived data More

number_of_channels

integer

Required

The total number of sampling poi More

spatial_sampling_interval

number

Required

The channel spacing, or offset, More

spatial_sampling_interval_units

string

Required

Unit of spatial sampling interva More

pulse_rate

number

Required

Rate at which the interrogator u More

pulse_rate_unit

string

Required

Unit of pulse rate

pulse_width

number

Required

Width of the pulse sent down the More

pulse_width_unit

string

Required

Unit of pulse width

comment

string

Required

Additional comments

native_headers

object

Required

Native headers

channel_groups

array

Required

Channel groups


acquisition > acquisition_id

Unique identifier of the data acquisition, assigned by data provider. Identifier should have the maximum of eight alphanumeric characters with no special characters (e.g., underscores, period, and dash). One identifier per acquisition settings.

Type:

string

Required:

Required

Possible Values:

dasid

Examples:

"A001"


acquisition > acquisition_start_time

Start time of this data acquisition in Coordinated Universal Time (UTC).

Type:

string

Required:

Required

Possible Values:

Format: date-time

Examples:

"2016-03-11T16:46:18.000Z"


acquisition > acquisition_end_time

End time of this data acquisition in UTC. If data acquisition is still in operation, use a date the future (e.g., 2999-01-01 00:00:00.000Z).

Type:

string

Required:

Required

Possible Values:

Format: date-time

Examples:

"2016-03-26T01:01:15.000Z"


acquisition > acquisition_sample_rate

The rate at which the interrogator provides output data.

Type:

number

Required:

Required

Possible Values:

0 < x

Examples:

1000


acquisition > acquisition_sample_rate_unit

Unit of acquisition sample rate.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"Hertz"


acquisition > gauge_length

The averaging length along the fiber for a measurement, determined at experiment setup and used during acquisition.

Type:

number

Required:

Required

Possible Values:

0 < x

Examples:

10


acquisition > gauge_length_unit

Unit of gauge length.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


acquisition > unit_of_measure

Unit of measure of archived data set. This may be the same unit as the Interrogator unit measure if the data are raw.

Type:

None

Required:

Required

Possible Values:

count strain strain-rate velocity

Examples:

"count"


acquisition > number_of_channels

The total number of sampling points along the fiber as output from the interrogator, referred to as NumberOfLoci in PRODML.

Type:

integer

Required:

Required

Possible Values:

1 <= x

Examples:

8720


acquisition > spatial_sampling_interval

The channel spacing, or offset, between channels.

Type:

number

Required:

Required

Possible Values:

0 < x

Examples:

1.0


acquisition > spatial_sampling_interval_units

Unit of spatial sampling interval.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


acquisition > pulse_rate

Rate at which the interrogator unit interrogates the fiber sensor.

Type:

number

Required:

Required

Possible Values:

0 <= x

Examples:

1000


acquisition > pulse_rate_unit

Unit of pulse rate.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"Hertz"


acquisition > pulse_width

Width of the pulse sent down the fiber in unit of time.

Type:

number

Required:

Required

Possible Values:

0 <= x


acquisition > pulse_width_unit

Unit of pulse width.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"nanoseconds"


acquisition > comment

Additional comments.

Type:

string

Required:

Required

Possible Values:

string


acquisition > native_headers

Native headers from the interrogator for this acquisition as a key-value list.

Type:

object

Required:

Required

Possible Values:

object

Examples:

{"header1": "Value of header1", "header2": "Value of header2", "header3": 99.4}


acquisition > channel_groups

One or more channel groups for this acquisition.

Type:

array

Required:

Required

Possible Values:

channel_group


Channel group metadata

The Channel Group metadata describes the properties that are common to all the channels nested under the Interrogator and Acquisition metadata blocks. Having a group-level metadata removes the repetition of common attributes in the individual Channel metadata. This design allows multiple channel groups to exist under the same interrogator and data acquisition settings. The unique identifiers for the interrogator, acquisition, cable and fiber are recorded as well in this metadata block to allows mapping between the interrogator, acquisition, and fiber that were used for this set of coordinates during a particular data collection.

Type: object

Channel group metadata

Property

Type

Required

Description

channel_group_id

string

Required

Unique identifier of the channel More

cable_id

string

Required

Unique identifier of cable linke More

fiber_id

string

Required

Unique identifier of fiber linke More

coordinate_generation_date

string

Required

Date that the channel coordinate More

coordinate_system

None

Required

Coordinate system used in channe More

reference_frame

string

Required

Geodetic datum and/or grid zone More

location_method

string

Required

Method used to determine the coo More

distance_along_fiber_unit

string

Required

Unit of distance along fiber

x_coordinate_unit

string

Required

Unit of x-coordinate (UTM-x or l More

uncertainty_in_x_coordinate

number

Required

Uncertainty in the x-coordinate More

uncertainty_in_x_coordinate_unit

string

Required

Unit of uncertainty in x-coordin More

y_coordinate_unit

string

Required

Unit of y-coordinate (UTM-y or l More

uncertainty_in_y_coordinate

number

Required

Uncertainty in the y-coordinate More

uncertainty_in_y_coordinate_unit

string

Required

Unit of uncertainty in y-coordin More

elevation_above_sea_level_unit

string

Required

Unit of elevation above sea leve More

uncertainty_in_elevation

number

Required

Uncertainty in elevation above s More

uncertainty_in_elevation_unit

string

Required

Unit of uncertainty in elevation

depth_below_surface_unit

string

Required

Unit of depth below surface

uncertainty_in_depth

number

Required

Uncertainty in depth below surfa More

uncertainty_in_depth_unit

string

Required

Unit of uncertainty in depth

strike_unit

string

Required

Unit of strike

uncertainty_in_strike

number

Required

Uncertainty in the strike

uncertainty_in_strike_unit

string

Required

Unit of uncertainty in strike

dip_unit

string

Required

Unit of dip

uncertainty_in_dip

number

Required

Uncertainty in the dip

uncertainty_in_dip_unit

string

Required

Unit of uncertainty in dip

first_usable_channel_id

string

Required

The first channel considered phy More

last_usable_channel_id

string

Required

The last channel considered phys More

comment

string

Required

Additional comments

channels

array

Required

Channels


channel_group > channel_group_id

Unique identifier of the channel group. Identifier should have the maximum of eight alphanumeric characters with no special characters (e.g., underscores, period, and dash).

Type:

string

Required:

Required

Possible Values:

dasid

Examples:

"CG001"


channel_group > cable_id

Unique identifier of cable linked to this channel group.

Type:

string

Required:

Required

Possible Values:

dasid

Examples:

"CA001"


channel_group > fiber_id

Unique identifier of fiber linked to this channel group. The fiber_id must nest within specified cable_id.

Type:

string

Required:

Required

Possible Values:

dasid

Examples:

"F001"


channel_group > coordinate_generation_date

Date that the channel coordinates were generated.

Type:

string

Required:

Required

Possible Values:

Format: date

Examples:

"2016-07-01"


channel_group > coordinate_system

Coordinate system used in channel location. Select geographic for coordinates in latitude and longitude. Universal Transverse Mercator (UTM) is the preferred projected coordinate system.

Type:

None

Required:

Required

Possible Values:

geographic UTM local

Examples:

"UTM"


channel_group > reference_frame

Geodetic datum and/or grid zone number in UTM.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"UTM Zone 11N", "WGS84"


channel_group > location_method

Method used to determine the coordinates of each channel. Example: tap test, GPS tracker.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"tap test"


channel_group > distance_along_fiber_unit

Unit of distance along fiber.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


channel_group > x_coordinate_unit

Unit of x-coordinate (UTM-x or longitude). Applies to every individual channel nested under the channel group.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"degree"


channel_group > uncertainty_in_x_coordinate

Uncertainty in the x-coordinate (UTM-x or longitude) representing the average uncertainty for all the channels.

Type:

number

Required:

Required

Possible Values:

0 <= x


channel_group > uncertainty_in_x_coordinate_unit

Unit of uncertainty in x-coordinate.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


channel_group > y_coordinate_unit

Unit of y-coordinate (UTM-y or latitude). Applies to every individual channel nested under the channel group.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"degree"


channel_group > uncertainty_in_y_coordinate

Uncertainty in the y-coordinate (UTM-y or latitude) representing the average uncertainty for all the channels.

Type:

number

Required:

Required

Possible Values:

0 <= x


channel_group > uncertainty_in_y_coordinate_unit

Unit of uncertainty in y-coordinate.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


channel_group > elevation_above_sea_level_unit

Unit of elevation above sea level. Applies to every individual channel nested under the channel group.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


channel_group > uncertainty_in_elevation

Uncertainty in elevation above sea level, representing the average uncertainty in elevation for all the coordinates.

Type:

number

Required:

Required

Possible Values:

0 <= x


channel_group > uncertainty_in_elevation_unit

Unit of uncertainty in elevation.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


channel_group > depth_below_surface_unit

Unit of depth below surface. Applies to every individual channel nested under the channel group.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


channel_group > uncertainty_in_depth

Uncertainty in depth below surface, representing the average uncertainty in depth for all the coordinates.

Type:

number

Required:

Required

Possible Values:

0 <= x


channel_group > uncertainty_in_depth_unit

Unit of uncertainty in depth.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


channel_group > strike_unit

Unit of strike. Applies to every individual channel nested under the channel group.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"degree"


channel_group > uncertainty_in_strike

Uncertainty in the strike.

Type:

number

Required:

Required

Possible Values:

0 <= x


channel_group > uncertainty_in_strike_unit

Unit of uncertainty in strike.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"degree"


channel_group > dip_unit

Unit of dip. Applies to every individual channel nested under the channel group.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"degree"


channel_group > uncertainty_in_dip

Uncertainty in the dip.

Type:

number

Required:

Required

Possible Values:

0 <= x


channel_group > uncertainty_in_dip_unit

Unit of uncertainty in dip.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"degree"


channel_group > first_usable_channel_id

The first channel considered physically meaningful. Typically, this will be a few channels after the last channel inside the interrogator. Must match one of the channel IDs.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"30"


channel_group > last_usable_channel_id

The last channel considered physically meaningful. Typically, an acquisition will add virtual channels at the end of the fiber or the optical path might not reach the end of the fiber, and this can be used to cut the data set into a working set. Must match one of the channel IDs.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"8650"


channel_group > comment

Additional comments.

Type:

string

Required:

Required

Possible Values:

string


channel_group > channels

One or more channels for this channel group.

Type:

array

Required:

Required

Possible Values:

channel


Channel metadata

Nested under the Channel Group metadata, the individual Channel metadata consists of properties that are unique to each channel, including a unique identifier, coordinates, and for borehole cable, optional strike and dip. Note that the total amount of individual Channel metadata may be equal or less than the number_of_channels attribute specified under Acquisition metadata as only a subset of the channels may be included in the data. This is to accommodate cases where channels cannot be located or omitted due to various reasons.

Type: object

Channel metadata

Property

Type

Required

Description

channel_id

string

Required

Unique identifier of the individ More

distance_along_fiber

number

Required

Distance along fiber between the More

x_coordinate

number

Required

x-coordinate (UTM-x or longitude More

y_coordinate

number

Required

y-coordinate (UTM-y or latitude) More

elevation_above_sea_level

number

Required

Elevation or height above sea le More

depth_below_surface

number

Required

Depth below surface (downward po More

strike

number

Required

Strike of individual channel

dip

number

Required

Dip of individual channel


channel > channel_id

Unique identifier of the individual channel, with the maximum of eight alphanumeric characters with no special characters (e.g., underscores, period, and dash).

Type:

string

Required:

Required

Possible Values:

dasid

Examples:

"431"


channel > distance_along_fiber

Distance along fiber between the interrogator and channel. Zero meter at the connector to the interrogator; and negative distances for fiber section inside the interrogator.

Type:

number

Required:

Required

Possible Values:

number


channel > x_coordinate

x-coordinate (UTM-x or longitude) of the channel.

Type:

number

Required:

Required

Possible Values:

number

Examples:

328050.69


channel > y_coordinate

y-coordinate (UTM-y or latitude) of the channel.

Type:

number

Required:

Required

Possible Values:

number

Examples:

4407542.05


channel > elevation_above_sea_level

Elevation or height above sea level.

Type:

number

Required:

Required

Possible Values:

number

Examples:

1231.546


channel > depth_below_surface

Depth below surface (downward positive).

Type:

number

Required:

Required

Possible Values:

number


channel > strike

Strike of individual channel.

Type:

number

Required:

Required

Possible Values:

number


channel > dip

Dip of individual channel.

Type:

number

Required:

Required

Possible Values:

number


Cable metadata

The Cable metadata is designed to allow investigators to describe the cable used in their experiment, which could be one continuous long cable, or cables with multiple connectors or across several installation environments. There are also parameters relating to the general geographical location of the cable to facilitate searchability in future databases. The Cable metadata should include available information on the cable and its installation as this knowledge may help in developing a system-level description of the exact cable response.

Type: object

Cable metadata

Property

Type

Required

Description

cable_id

string

Required

Unique identifier for the specif More

cable_bounding_box

array

Required

List of approximate coordinates More

cable_owner

string

Required

Proprietary owner of the cable

cable_installation_date

string

Required

Cable installation date in Coord More

cable_removal_date

string

Required

Cable removal date in UTC

cable_characteristics

string

Required

Describes how the fiber is encas More

cable_environment

string

Required

Describes the installation envir More

cable_installation_environment

string

Required

Plain language description of ho More

cable_model

string

Required

Cable manufacturer model

cable_outside_diameter

number

Required

Cable outside diameter

cable_outside_diameter_unit

string

Required

Unit of outside diameter of cabl More

comment

string

Required

Additional comments

fibers

array

Required

Fibers


cable > cable_id

Unique identifier for the specific physical cable used in the data acquisition. Identifier should have the maximum of eight alphanumeric characters with no special characters (e.g., underscores, period, and dash).

Type:

string

Required:

Required

Possible Values:

dasid

Examples:

"CA001"


cable > cable_bounding_box

List of approximate coordinates of the bounding box containing the array [minimum latitude, maximum latitude, minimum longitude, and maximum longitude].

Type:

array

Required:

Required

Possible Values:

number

Examples:

[39.797, 39.813, -119.013, -118.995]


cable > cable_owner

Proprietary owner of the cable.

Type:

string

Required:

Required

Possible Values:

string


cable > cable_installation_date

Cable installation date in Coordinated Universal Time (UTC). This may not be known, an optional field.

Type:

string

Required:

Required

Possible Values:

Format: date


cable > cable_removal_date

Cable removal date in UTC. This may not be known, an optional field.

Type:

string

Required:

Required

Possible Values:

Format: date


cable > cable_characteristics

Describes how the fiber is encased in the cable.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"buffered", "armored", "gel-filled"


cable > cable_environment

Describes the installation environment of cable [conduit| trench | outside borehole casing | wireline | other ].

Type:

string

Required:

Required

Possible Values:

string

Examples:

"trench", "conduit"


cable > cable_installation_environment

Plain language description of how the cable was installed.

Type:

string

Required:

Required

Possible Values:

string


cable > cable_model

Cable manufacturer model.

Type:

string

Required:

Required

Possible Values:

string


cable > cable_outside_diameter

Cable outside diameter.

Type:

number

Required:

Required

Possible Values:

0 < x


cable > cable_outside_diameter_unit

Unit of outside diameter of cable.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"millimeter"


cable > comment

Additional comments.

Type:

string

Required:

Required

Possible Values:

string


cable > fibers

One or more Fibers for this cable

Type:

array

Required:

Required

Possible Values:

fiber


Fiber metadata

The intention for a separate Fiber metadata is to uniquely identify the fiber used to make the measurements. More than one cable may be used over the course of an experiment and there may be several fibers within a cable.

Type: object

Fiber metadata

Property

Type

Required

Description

fiber_id

string

Required

Unique identifier for the physic More

fiber_geometry

string

Required

Geometry of fiber [linear | heli More

fiber_mode

string

Required

Mode of fiber [single-mode | mul More

fiber_refraction_index

number

Required

Refractive index of the fiber (u More

fiber_winding_angle

number

Required

If helical, this is the winding More

fiber_winding_angle_unit

string

Required

Unit of fiber winding angle

fiber_start_location

number

Required

The start distance along the fib More

fiber_start_location_unit

string

Required

Unit of fiber start location

fiber_end_location

number

Required

The end location or distance alo More

fiber_end_location_unit

string

Required

Unit of fiber end location

fiber_optic_length

number

Required

Total length of this fiber

fiber_optic_length_unit

string

Required

Unit of fiber-optical length

fiber_one_way_attenuation

number

Required

Power loss for one-way travel of More

fiber_one_way_attenuation_unit

string

Required

Unit of fiber one way attenuatio More

comment

string

Required

Additional comments


fiber > fiber_id

Unique identifier for the physical fiber, with the maximum of eight alphanumeric characters with no special characters (e.g., underscores, period, and dash).

Type:

string

Required:

Required

Possible Values:

dasid

Examples:

"F001"


fiber > fiber_geometry

Geometry of fiber [linear | helical | other].

Type:

string

Required:

Required

Possible Values:

string

Examples:

"linear", "helical"


fiber > fiber_mode

Mode of fiber [single-mode | multi-mode | other].

Type:

string

Required:

Required

Possible Values:

string

Examples:

"single-mode", "multi-mode"


fiber > fiber_refraction_index

Refractive index of the fiber (unitless). Typical value for single-mode fiber is 1.4681.

Type:

number

Required:

Required

Possible Values:

0 <= x

Examples:

1.4681


fiber > fiber_winding_angle

If helical, this is the winding angle relative to the center of the cable.

Type:

number

Required:

Required

Possible Values:

number


fiber > fiber_winding_angle_unit

Unit of fiber winding angle.

Type:

string

Required:

Required

Possible Values:

string


fiber > fiber_start_location

The start distance along the fiber with respect to the interrogator, referred to as StartLocus in PRODML.

Type:

number

Required:

Required

Possible Values:

number


fiber > fiber_start_location_unit

Unit of fiber start location.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


fiber > fiber_end_location

The end location or distance along the fiber with respect to the interrogator.

Type:

number

Required:

Required

Possible Values:

number


fiber > fiber_end_location_unit

Unit of fiber end location.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


fiber > fiber_optic_length

Total length of this fiber. Typically, it is the sum of fiber_start_location and fiber_end_location.

Type:

number

Required:

Required

Possible Values:

0 < x

Examples:

8400


fiber > fiber_optic_length_unit

Unit of fiber-optical length.

Type:

string

Required:

Required

Possible Values:

string

Examples:

"meter"


fiber > fiber_one_way_attenuation

Power loss for one-way travel of a beam of light. Typical value for single mode fiber is 0.4.

Type:

number

Required:

Required

Possible Values:

0 < x


fiber > fiber_one_way_attenuation_unit

Unit of fiber one way attenuation [decibels/meter | decibels/kilometer].

Type:

string

Required:

Required

Possible Values:

string

Examples:

"decibels/meter"


fiber > comment

Additional comments.

Type:

string

Required:

Required

Possible Values:

string


dasid

No description provided for this model.

Type: string