# Class: OpticalPath

## opticalPath.OpticalPath(options)

An Optical Path. An optical path represents a color or a monochromatic image that was acquired using specific microscopy settings. Usually, an optical path is also associated with specific specimen preparation steps, in particular one or more staining steps. For example, in immunofluorescence microscopy imaging, an optical path is generally associated with a specific fluorescence illumination wave length or color (e.g., 568nm in the red spectrum of the visible light) and an antibody or a set of antibodies labeled with a corresponding fluorophore that can be excited by light at the illumination wave length and re-emit light (usually at a slightly higher wave length) upon excitation. Note, however, that multiple stains may be applied to the imaging target (specimen) during specimen preparation, and multiple images may be acquired using different optical paths - either simultaneously or sequentially. The content of an image thus depends on the physical properties of the tissue stains (fluorophores) as well as the characteristics of the optical path (illumination wave length, light and image path filters, etc.). An optical path is identified by an optical path identifier that must be unique within the scope of an image acquisition (or multiple cycles of image acquisition in case of iterative immunofluorescence imaging). The relationship between the optical path and any corresponding staining specimen preparation steps may not be explicitly specified.

## Constructor

#### new OpticalPath(options)

##### Parameters:

Name | Type | Description
--- | --- | ---
`options` | Object | Options ###### Properties
Name | Type | Description
--- | --- | ---
`identifier` | string | Optical Path Identifier
`description` | string | Optical Path Description
`illuminationType` | Object | Illumination Type Code
`isMonochromatic` | boolean | Whether optical path is monochromatic
`illuminationColor` | Object | undefined | Illumination Color Code
`illuminationWaveLength` | string | undefined | Illumination Wave Length
`studyInstanceUID` | string | Study Instance UID of VL Whole Slide Microscopy Image instances
`seriesInstanceUID` | string | Series Instance UID of VL Whole Slide Microscopy Image instances
`sopInstanceUIDs` | Array.<string> | SOP Instance UIDs of VL Whole Slide Microscopy Image instances
`paletteColorLookupTableUID` | string | undefined | Palette Color Lookup Table UID

Source:
  - opticalPath.js, line 33

### Members

#### description :string

Optical Path Description

##### Type:

- string

Source:
  - opticalPath.js, line 114

#### identifier :string

Optical Path Identifier

##### Type:

- string

Source:
  - opticalPath.js, line 105

#### illuminationColor :object

Illumination Color

##### Type:

- object

Source:
  - opticalPath.js, line 132

#### illuminationType :object

Illumination Type Code

##### Type:

- object

Source:
  - opticalPath.js, line 123

#### illuminationWaveLength :string|undefined

Illumination Wave Length

##### Type:

- string | undefined

Source:
  - opticalPath.js, line 141

#### isColorable :boolean

Whether images of optical path are colorable

##### Type:

- boolean

Source:
  - opticalPath.js, line 195

#### isMonochromatic :boolean

Whether optical path is monochromatic

##### Type:

- boolean

Source:
  - opticalPath.js, line 186

#### paletteColorLookupTableUID :string

Palette Color Lookup Table UID

##### Type:

- string

Source:
  - opticalPath.js, line 177

#### seriesInstanceUID :string

Series Instance UID of images

##### Type:

- string

Source:
  - opticalPath.js, line 159

#### sopInstanceUIDs :Array.<string>

SOP Instance UIDs of images

##### Type:

- Array.<string>

Source:
  - opticalPath.js, line 168

#### studyInstanceUID :string

Study Instance UID of images

##### Type:

- string

Source:
  - opticalPath.js, line 150