PolarizationAnalysis
StokesVector - GetFrame
Returns a Size object containing the width and height of each polarization image.
IN
| Name | Type | Description |
|---|---|---|
| InStokesVector | StokesVector | The input StokesVector |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSize | Size | Size object with frame dimensions. |
| Error | ErrorState | Gets the execution error message |
StokesVector - GetS0
Returns a reference to the component S0 of the Stokes vector.
IN
| Name | Type | Description |
|---|---|---|
| InStokesVector | StokesVector | The input StokesVector |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutS0 | Image | Reference to the Stokes component. |
| Error | ErrorState | Gets the execution error message |
StokesVector - GetS1
Returns a reference to the component S1 of the Stokes vector.
IN
| Name | Type | Description |
|---|---|---|
| InStokesVector | StokesVector | The input StokesVector |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutS1 | Image | Reference to the Stokes component. |
| Error | ErrorState | Gets the execution error message |
StokesVector - GetS2
Returns a reference to the component S2 of the Stokes vector.
IN
| Name | Type | Description |
|---|---|---|
| InStokesVector | StokesVector | The input StokesVector |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutS2 | Image | Reference to the Stokes component. |
| Error | ErrorState | Gets the execution error message |
PolarizationDemosaicing - ComputeBlockMatrix
Shuffles each pixel of the image so that the output image is divided into 4 areas, where each area only contains pixels with the same polarization angle. Note: The placement of the 4 polarizations on the output image match the pattern of the input polarization pattern. The result is correct only for images acquired with a monochrome sensor. Only single channel UInt8 and UInt16 input images are supported.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Raw image, acquired using a monochrome sensor with polarization filter array. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutBlockMatrix | Image | Block matrix computed from the raw image. |
| Error | ErrorState | Gets the execution error message |
PolarizationDemosaicing - Demosaic_Color
Applies the demosaicing algorithm to a raw image acquired using a color sensor with polarization filter array. Note: Size and type of the output channels depend on the demosaicing algorithm. See the details for the pa::demosaic function for more information. Only single channel UInt8 and UInt16 input images are supported.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Raw image, acquired using a color sensor with polarization filter array. |
| InDemosaicingAlgorithm | Enum < DemosaicingAlgorithm > | Demosaicing algorithm applied to the raw image. |
| InBayerType | Enum < BayerType > | Color pattern of the polarization filter array. |
| InPolarizationPattern | Enum < PolarizationPattern > | Polarization pattern of the polarization filter array. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRedChannels | PolarizationChannels | Polarization channels associated to the red pixels of the raw image. |
| OutGreenChannels | PolarizationChannels | Polarization channels associated to the green pixels of the raw image. |
| OutBlueChannels | PolarizationChannels | Polarization channels associated to the blue pixels of the raw image. |
| Error | ErrorState | Gets the execution error message |
PolarizationDemosaicing - Demosaic_Mono
Applies the demosaicing algorithm to an image acquired using a monochrome sensor with polarization filter array. Note: Size and type of the output components depend on the demosaicing algorithm. In particular, considering an input image with size (w, h) and type T, the following is valid: - DemosaicingAlgorithm::None returns components with size (w/2, h/2) and type T - DemosaicingAlgorithm::NearestNeighbour returns components with size (w - 2, h - 2) and type T - DemosaicingAlgorithm::Bilinear returns components with size (w - 3, h - 3) and type T - DemosaicingAlgorithm::WeightedBilinear returns components with size (w - 4, h - 4) and type Float Only single channel UInt8 and UInt16 input images are supported.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Raw image, acquired using a monochrome sensor with polarization filter array. |
| InDemosaicingAlgorithm | Enum < DemosaicingAlgorithm > | Demosaicing algorithm applied to the raw image. |
| InPolarizationPattern | Enum < PolarizationPattern > | Pattern of the polarization filter array. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutChannels | PolarizationChannels | Polarization channels computed starting from the raw image. |
| Error | ErrorState | Gets the execution error message |
PolarizationDemosaicing - ExtractChannel
Extracts a single polarization channel from an image acquired using a monochrome sensor with polarization filter array. Note: Size and type of the output image depend on the demosaicing algorithm. See the details for the pa::demosaic function for more information. Only single channel UInt8 and UInt16 input images are supported.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Raw image, acquired using a monochrome sensor with polarization filter array. |
| InPolarizationAngle | Enum < PolarizationAngle > | Selects the polarization angle that will be extracted. |
| InDemosaicingAlgorithm | Enum < DemosaicingAlgorithm > | Demosaicing algorithm applied to the raw image. |
| InPolarizationPattern | Enum < PolarizationPattern > | Pattern of the polarization filter array. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutChannel | Image | Single polarization component extracted from the raw image. |
| Error | ErrorState | Gets the execution error message |
PolarizationChannels - GetFrame
Returns a Size object containing the width and height of each polarization image.
IN
| Name | Type | Description |
|---|---|---|
| InPolarizationChannels | PolarizationChannels | The input PolarizationChannels |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSize | Size | Size object with frame dimensions. |
| Error | ErrorState | Gets the execution error message |
PolarizationChannels - GetPixelType
Returns the pixel type of each polarization image. Note: The image type depends on the polarization demosaicing algorithm applied to the original image.
IN
| Name | Type | Description |
|---|---|---|
| InPolarizationChannels | PolarizationChannels | The input PolarizationChannels |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPixelType | Enum < PixelType > | Pixel type. |
| Error | ErrorState | Gets the execution error message |
PolarizationChannels - GetPolarization0
Returns a reference to the demosaicked polarization at 0 degrees.
IN
| Name | Type | Description |
|---|---|---|
| InPolarizationChannels | PolarizationChannels | The input PolarizationChannels |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutP0 | Image | Reference to the demosaicked polarization. |
| Error | ErrorState | Gets the execution error message |
PolarizationChannels - GetPolarization135
Returns a reference to the demosaicked polarization at 135 degrees.
IN
| Name | Type | Description |
|---|---|---|
| InPolarizationChannels | PolarizationChannels | The input PolarizationChannels |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutP135 | Image | Reference to the demosaicked polarization. |
| Error | ErrorState | Gets the execution error message |
PolarizationChannels - GetPolarization45
Returns a reference to the demosaicked polarization at 45 degrees.
IN
| Name | Type | Description |
|---|---|---|
| InPolarizationChannels | PolarizationChannels | The input PolarizationChannels |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutP45 | Image | Reference to the demosaicked polarization. |
| Error | ErrorState | Gets the execution error message |
PolarizationChannels - GetPolarization90
Returns a reference to the demosaicked polarization at 90 degrees.
IN
| Name | Type | Description |
|---|---|---|
| InPolarizationChannels | PolarizationChannels | The input PolarizationChannels |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutP90 | Image | Reference to the demosaicked polarization. |
| Error | ErrorState | Gets the execution error message |
PolarizationAnalysis - ComputeLinearPolarizationComponents
Computes the matrices used to describe the linear polarization of light. Note: The size of the output matrices match the size of the Stokes vector components. Type is always Float with a single channel.
IN
| Name | Type | Description |
|---|---|---|
| InStokesVector | StokesVector | Stokes vector computed from the raw image. |
| InLumaNormalizationValue | Int | Value used to normalize the Luminance matrix. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutStokesVector | StokesVector | The modified Core.Data.Types.StokesVector |
| Error | ErrorState | Gets the execution error message |
PolarizationAnalysis - ComputeLinearPolarizationComponents_ColorDirect
Computes the matrices describing the linear polarization of light associated to an image acquired using a color sensor with polarization filter array. Note: The size of the output images depend on the demosaicing algorithm. See the details for the pa::demosaic function for more information. Type is always Float with 3 channels. When using this overload, the output images have 3 channels each, following the RGB format.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Raw image, acquired using a color sensor with polarization filter array. |
| InDemosaicingAlgorithm | Enum < DemosaicingAlgorithm > | Demosaicing algorithm applied to the raw image. |
| InBayerType | Enum < BayerType > | Color pattern of the polarization filter array. |
| InPolarizationPattern | Enum < PolarizationPattern > | Polarization pattern of the polarization filter array. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
PolarizationAnalysis - ComputeLinearPolarizationComponents_MonoDirect
Computes the matrices describing the linear polarization of light associated to an image acquired using a monochrome sensor with polarization filter array. Note: The size of the output images depend on the demosaicing algorithm. See the details for the pa::demosaic function for more information. Type is always Float with a single channel.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Raw image, acquired using a monochrome sensor with polarization filter array. |
| InDemosaicingAlgorithm | Enum < DemosaicingAlgorithm > | Demosaicing algorithm applied to the raw image. |
| InPolarizationPattern | Enum < PolarizationPattern > | Polarization pattern of the polarization filter array. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
PolarizationAnalysis - ComputeStokesVector
Computes all the components of the Stokes vector associated to the input polarization channels. Note: The size of the Stokes components match the size of the input matrices, while the type is always Float.
IN
| Name | Type | Description |
|---|---|---|
| InPolarizationChannels | PolarizationChannels | Polarization channels demosaicked from the raw image. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutStokesVector | StokesVector | Computed Stokes vector. |
| Error | ErrorState | Gets the execution error message |
PolarizationAnalysis - ComputeStokesVector_Components
Computes the components of the Stokes vector associated to the input polarization channels. Note: The size of the Stokes components match the size of the input matrices, while the type is always Float. For performance reasons, use this overload only when some (and not all) of the components are required.
IN
| Name | Type | Description |
|---|---|---|
| InPolarizationChannels | PolarizationChannels | Polarization channels demosaicked from the raw image. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPolarizationChannels | PolarizationChannels | The modified Core.Data.Types.PolarizationChannels |
| Error | ErrorState | Gets the execution error message |
PolarizationAnalysis - VirtualPolarizer
Simulates the system's polarization state, given the acquired StokesVector and the virtual polarizer orientation. Note: The matrices of the output PolarizationChannels are of type Float, independently of the demosaicing applied during the acquisition.
IN
| Name | Type | Description |
|---|---|---|
| InStokesVector | StokesVector | Stokes Vector of the current system state. The image can be acquired in any state （e.g. with polarized light, with unpolarized light）. |
| InPolarizerAngle | Float | Angle of the simulated polarization filter, expressed relative to camera orientation. The value should be expressed in degrees. |
| InPolarizerEfficiency | Float | Efficiency of the virtual polarizer. Set to 1 to simulate the perfect polarizer. Range 〔0, 1〕. |
| InPolarizerReflectivity | Float | Reflectivity of the virtual polarizer. Set to 0 to simulate the perfect polarizer. Range 〔0, 1〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutVirtualStokesVector | StokesVector | StokesVector of the simulated system. |
| Error | ErrorState | Gets the execution error message |