Contents Menu Expand Light mode Dark mode Auto light/dark mode
Phase One SDK
Light Logo Dark Logo

Documentation

  • Introduction
  • Setting the Stage
  • Getting started
    • CameraSDK : C++
    • CameraSDK : C# (Windows)
    • ImageSDK : C++
    • ImageSDK : C# (Windows)
  • Features Overview
  • The Connection
  • Download
    • Releases Archive
  • CameraSDK Features
    • Opening the Camera
    • Properties
    • Notifications
    • Triggering a Capture
    • Subscriptions
      • Receive Captured Images
      • Previews On Capture
      • LiveView
    • Image Browsing
    • Capabilities
    • Firmware Upgrade
    • Diagnostics Logs
    • Memory Management
  • ImageSDK Features
    • Eager Initialization
    • Utilizing GPU for accelerated processing
    • Open Image
    • Meta Data System
    • Output Formats
    • Decode Pipeline
    • Convert Pipeline
    • Export image

C++ Reference

  • CameraSDK
    • Camera
    • Listener
    • PropertySpecification
    • PropertyValue
    • PropertyRange
    • INotificationEvent
    • EventType
    • PropertyEventType
    • SdkEventType
    • IImageFileBasicInfo
      • enum P1::CameraSdk::IImageFileBasicInfo::CompressionSetting
      • enum P1::CameraSdk::IImageFileBasicInfo::OrientationModeSetting
      • enum P1::CameraSdk::IImageFileBasicInfo::StarRating
      • enum P1::CameraSdk::IImageFileBasicInfo::WhiteBalanceSetting
    • IImageBuffer
      • enum P1::CameraSdk::IImageBuffer::Type
    • IImageBufferFrame
    • IPreview
    • ITile
    • ILiveView
    • IFullImage
    • IStoredImageHandle
      • enum P1::CameraSdk::IStoredImageHandle::DeviceMask
      • struct P1::CameraSdk::IStoredImageHandle::TileRequest
    • CameraListElement
    • CameraInfo
    • ICameraCapabilities
    • ImageFormat
    • ISubscriptionManager
    • IPreviewSubscription
    • ILiveViewSubscription
    • IFullImageSubscription
    • ISubscription
  • ImageSDK
    • RawImage
    • ConvertConfig
    • DecodeConfig
    • BitmapImage
    • BitmapFormat
      • enum P1::ImageSdk::BitmapFormat::PredefinedBitmapFormat
    • TiffWriter
    • JpegWriter
    • Jp2Writer
    • PgmWriter
    • IiqWriter
    • Stitching
    • Stacking
    • SensorBayerOutput
    • ImageTag
    • TagId
    • MetaDataBase
    • MetaObject
    • BayerFormat
    • BlackClamp
    • DigitalOffset
    • Histogram

C# Reference

  • CameraSDK
    • Camera
      • Subscriptions
      • Close
      • IsOpen
      • ConnectionType
      • AllPropertyIds
      • PropertySpec
      • SetProperty
      • Property
      • UploadFile
      • DownloadFile
      • UpdateCameraFirmware
      • UpdateCameraFirmware
      • TriggerCapture
      • SetHostStorageCapacity
      • ToString
      • Dispose
      • AllImages
      • AvailableCameras
      • OpenUsbCamera
      • OpenIpCamera
    • Listener
      • Listener
      • Listener
      • Listener
      • Id
      • EnableNotification
      • EnableNotification
      • EnableNotification
      • EnableCatchAllNotifications
      • DisableNotification
      • DisableNotification
      • DisableNotification
      • DisableCatchAllNotification
      • WakeUpWaitingThread
      • WaitForNotification
      • Dispose
    • PropertySpec
      • Id
      • Value
      • Name
      • GroupName
      • ReadOnly
      • Enabled
      • ValueMapper
      • Range
      • UserLevel
      • SelectOnly
      • DisplayAsHex
      • RefreshRequired
      • DisplayIndex
      • UnitString
      • Description
      • Default
      • ToString
    • PropertyValue
      • PropertyValue
      • Type
      • IntValue
      • FloatValue
      • StringValue
      • PointValue
      • ColorValue
      • AreaValue
      • AreaFloatValue
      • RectValue
      • RangeValue
      • RangeFloatValue
      • PresentationString
      • IconId
      • GetHashCode
      • Equals
      • Equals
      • ToString
      • operator==
      • operator!=
      • operator PropertyValue
      • operator PropertyValue
      • operator PropertyValue
      • operator PropertyValue
      • operator PropertyValue
      • operator PropertyValue
      • operator PropertyValue
      • operator PropertyValue
      • operator bool
      • operator Int32
      • operator Int64
      • operator UInt32
      • operator UInt64
      • operator double
      • operator string
    • PropertyRange
      • Has
      • Min
      • Max
      • Equals
      • GetHashCode
    • INotificationEvent
      • Type
      • HasImageFilename
      • ImageId
      • HasCamera
      • Camera
      • CameraId
      • PropertyId
      • IsCameraEvent
      • IsSdkEvent
      • IsPropertyEvent
      • IsTransferEvent
      • IsImageEvent
      • BasicImageInfo
      • Preview
      • Tile
      • LiveView
      • FullImage
      • StoredImageHandle
      • CameraInfo
      • TransferProgressPercent
      • ImageFilename
      • QueueMode
      • ToString
    • EventType
      • Invalid
      • ImageTransferBegin
      • ImageTransferProgress
      • CameraImageReady
      • CameraDisconnected
      • CameraLiveViewStarted
      • CameraLiveViewStopped
      • CameraNewLiveViewImage
      • CameraPropertyAdded
      • CameraPropertyRemoved
      • CameraImageAdded
      • CameraImageRemoved
      • CameraImageEdited
      • CameraImageNewList
      • CameraPreviewReady
      • CameraTileReady
      • CameraImageBasicImageInfo
      • FirmwareTransferBegin
      • FirmwareTransferProgress
      • FirmwareTransferDone
      • FirmwareTransferError
      • FileTransferBegin
      • FileTransferProgress
      • FileTransferDone
      • FileTransferError
    • PropertyEventType
      • PropertyValueChange
      • PropertySpecificationChange
    • SdkEventType
      • SdkWakeUp
      • CameraFound
      • CameraRemoved
      • CameraOpened
      • CameraClosed
    • IImageFileBasicInfo
      • Aperture
      • Shutter
      • FocusPointX
      • FocusPointY
      • FocalLength
      • WhiteBalance
      • Compression
      • Orientation
      • ImageWidth
      • ImageHeight
      • Iso
      • Rating
      • TimeStamp
      • ImageSize
      • Name
      • ToString
    • IImageBuffer
      • Data
      • Format
      • BufferType
      • ToString
    • IImageBufferFrame
      • DestinationWidth
      • DestinationHeight
    • IPreview
    • ITile
      • SourceOffsetX
      • SourceOffsetY
      • SourceWidth
      • SourceHeight
      • ScaleFactor
    • ILiveView
      • CompressionQuality
      • IsCompressed
      • SourceCrop
      • RequestedCrop
      • SourceFullImageSize
    • IFullImage
      • FileName
    • IStoredImageHandle
      • Id
      • Date
      • Filename
      • Device
      • RequestBasicImageInfoAsync
      • BasicImageInfo
      • RequestImageAsync
      • RequestPreviewAsync
      • Preview
      • RequestTileAsync
      • Tile
      • DeleteImage
      • RateImage
    • CameraDescriptor
      • Connection
      • Name
      • SerialNum
      • IPv4
      • IsOpen
      • ToString
    • CameraInfo
      • ConnectionType
      • Name
      • Serial
      • IpV4
      • ToString
    • ICameraCapabilities
      • GetMaxNoPixelsPreview
      • GetMaxNoPixelsTile
    • ImageFormat
    • SubscriptionManager
      • Previews
      • LiveView
      • FullImages
    • IPreviewSubscription
      • ImageFormatsSupported
      • Format
      • Subscribe
    • ILiveViewSubscription
      • ImageFormatsSupported
      • Format
      • Crop
      • PreferredMaxDimension
      • FullImageSize
      • Lightness
      • Subscribe
      • ResetCrop
      • SetWhiteBalancePoint
    • IFullImageSubscription
    • ISubscription
      • IsSupported
      • IsSubscribed
      • Subscribe
      • Unsubscribe
  • ImageSDK
    • RawImage
      • RawImage
      • RawImage
      • RawImage
      • outputImage
      • Width
      • Height
      • RawSensorWidth
      • RawSensorHeight
      • Decode
      • Convert
      • Convert
      • Convert
      • ComputeSharpnessOnRegion
      • SetRoundCornerRadius
      • GetTag
      • TagExists
      • GetPreview
      • GetXmpPacket
      • GetGpsData
      • GetRawHistogramData
      • SetGainMask
    • ConvertConfig
      • ConvertConfig
      • ExposureRange
      • ContrastRange
      • BrightnessRange
      • SaturationRange
      • ShadowRecoveryRange
      • HighlightRecoveryRange
      • BlackLevelRange
      • WhiteLevelRange
      • MidtoneLevelRange
      • CurveInOutRange
      • ClarityMethodRange
      • ClarityFactorRange
      • SharpeningAmountRange
      • SharpeningRadiusRange
      • SharpeningThresholdRange
      • HaloSuppressionAmountRange
      • AerialDehazingAmountRange
      • AerialDehazingAdaptivityRange
      • LuminanceNoiseReductionAmountRange
      • ColorNoiseReductionAmountRange
      • WhiteBalanceGainRange
      • GeometricCorrectionFocalLengthRange
      • GeometricCorrectionPixelPitchRange
      • GeometricCorrectionShiftRange
      • GeometricCorrectionPolinomRange
      • GeometricCorrectionAffinityRange
      • outputImage
      • Crop
      • OutputScaleFactor
      • OutputWidth
      • OutputHeight
      • Version
      • Exposure
      • Contrast
      • Brightness
      • Saturation
      • HighlightRecovery
      • ShadowRecovery
      • BlackLevel
      • BlackLevelTarget
      • MidtoneLevel
      • WhiteLevel
      • WhiteLevelTarget
      • RedCurve
      • GreenCurve
      • Gain
      • BlueCurve
      • LumaCurve
      • RGBCurve
      • WhiteBalanceGain
      • WhiteBalanceMode
      • Clarity
      • LuminanceNoiseReductionAmount
      • NoiseReductionSinglePixel
      • ColorNoiseReductionAmount
      • NoiseReductionPerformanceOptimized
      • SharpeningAmount
      • SharpeningRadius
      • SharpeningThreshold
      • HaloSuppressionAmount
      • AerialDehazingAdaptivity
      • AerialDehazingAmount
      • GeometricCorrectionEnabled
      • GeometricCorrectionMethod
      • ColorAntiAliasingEnabled
      • GeometricCorrectionCompensationEnabled
      • GeometricCompensationPressure
      • GeometricCorrection
      • LightFalloffCorrectionEnabled
      • DualExposureOutput
      • EnableLinearPath
      • LinearPathType
      • EnableAutoExposure
      • PolynomialTransform
      • PolynomialTransformNormalized
      • PolynomialTransformStage
      • Orientation
      • ChromaticAberrationCorrectionEnabled
      • ExposureWarningMaskEnabled
      • ExposureWarningThresholdOver
      • ExposureWarningThresholdUnder
      • ClipWarningMaskEnabled
      • ClipWarningCount
      • CanvasClip
      • FilmCurveFileName
      • IccProfileFileName
      • Clone
      • GetDiscretizedRedCurve
      • GetDiscretizedGreenCurve
      • GetDiscretizedBlueCurve
      • GetDiscretizedLumaCurve
      • GetDiscretizedRgbCurve
      • SetAerialDehazing
      • SetOutputFormat
      • OutputFormat
      • SetOutputColorSpace
      • OutputColorSpace
      • SetCanvasClip
      • SetCrop
      • SetCrop
      • ResetCrop
      • ResetOutputScaling
      • SetOutputScale
      • SetOutputWidth
      • SetOutputHeight
      • SetContrast
      • SetBrightness
      • SetSaturation
      • SetExposure
      • SetPolynomialTransformation
      • SetPolynomialTransformationNormalized
      • SetPolynomialTransformationNormalized_EndPipeline
      • SetGain
      • SetBlackLevel
      • SetBlackLevelTarget
      • SetMidtoneLevel
      • SetWhiteLevel
      • SetWhiteLevelTarget
      • SetSharpening
      • SetLuminanceNoiseReductionAmount
      • SetNoiseReductionSinglePixelEnabled
      • SetNoiseReductionPerformanceOptimized
      • SetColorNoiseReductionAmount
      • SetClarity
      • SetShadowRecovery
      • SetHighlightRecovery
      • SetWhiteBalanceGain
      • SetWhiteBalanceMode
      • SetGeometricCorrectionEnabled
      • SetGeometricCorrectionMethod
      • SetColorAntiAliasingEnabled
      • SetGeometricCorrection
      • SetGeometricCorrectionCompensationEnabled
      • SetGeometricCorrectionCompensationPressure
      • SetEnableLinearPath
      • SetEnableAutoExposure
      • SetLinearPathType
      • SetOrientation
      • SetDualExposureOutput
      • SetExposureMaskThreshold
      • SetMaskThresholdClipWarningCount
      • SetRedCurve
      • SetGreenCurve
      • SetBlueCurve
      • SetLumaCurve
      • SetRgbCurve
      • SetFilmCurve
      • GetFilmCurve
      • SetIccProfile
      • GetIccProfile
      • SaveToFile
      • Serialize
      • ApplyTo
      • ApplyTo
      • ApplyTo
      • LoadFromFile
      • Deserialize
      • Discretize
    • DecodeConfig
      • DecodeConfig
      • BlackClamp
      • DigitalOffset
      • dualExposureMode
      • SetDualExposureOutput
      • BlackLeveling
      • ApplyTo
      • Defaults
    • BitmapImage
      • BitmapImage
      • BitmapImage
      • Format
      • Width
      • Height
      • BitsPerSample
      • SamplesPerPixel
      • SourceCrop
      • ColorSpace
      • Stride
      • DebugPrint
      • GetIntPtr
    • BitmapFormat
      • BitmapFormat
      • BitmapFormat
      • BitmapFormat
      • BitmapFormatType
      • BitDepth
      • PixelLayout
      • PixelComponent
      • GetBitsPerSample
      • SetAlignment
      • Equals
      • operator BitmapFormat
      • operator==
      • operator!=
      • operator int
    • Stitching
      • Stitching
      • Dispose
      • CalculateAverageLumaForOverlap
      • CalculateGainForPas280Overlap
      • DoStitching
      • DoStitching
      • DoPasPanaStitching
      • SetFineCalibration
      • GetFineCalibration
      • GetLastResult
    • Stacking
      • Stacking
      • Dispose
      • DoStacking
      • DoStacking
      • DoPasPanaStacking
      • SetFineCalibration
      • GetFineCalibration
      • GetLastResult
    • SensorBayerOutput
      • ActiveArea
      • FullWidth
      • FullHeight
      • GainAndOffset
      • Transform
      • Transform
    • ImageTag
      • TagId
      • Type
      • Count
      • ByteSize
      • Data
      • StringValue
      • IntValue
      • UIntValue
      • DoubleValue
      • RationalValue
      • URationalValue
      • ToString
      • operator byte
      • operator Int32
      • operator UInt32
      • operator double
      • operator string
    • TagId
      • TagId
      • Type
      • Id
      • Category
      • Equals
    • GpsData
      • GpsDateTimeStamp
      • LatitudeDegrees
      • LatitudeMinutes
      • LatitudeSign
      • LongitudeDegrees
      • LongitudeMinutes
      • LongitudeSign
      • AltitudeMeters
      • LatitudeAsDecimal
      • LongitudeAsDecimal
      • ToString
    • ImuData
      • Yaw
      • Pitch
      • Roll
      • YawRef
      • ToString
    • GpsDateTimeComponents
      • HasDate
      • Year
      • Month
      • Day
      • Hours
      • Minutes
      • Seconds
      • IsGpsTime
      • ToTimeSpan
      • ToDateTime
      • ToString
    • BlackClamp
    • DigitalOffset
    • Histogram
      • Histogram
      • Histogram
      • GetDataSizeBytes
      • GetDataChannel

Appendices

  • Release Notes
    • CameraSDK 3 Migration Guide
  • Error Handling and Logging
  • Parallelism in ImageSDK
  • Sample Applications
    • “Connect, Set, Decode!”
    • “Open and Save File”
    • Try/Catch Explanation
    • CamTool Sample
    • 0. Open, convert and export
    • 1. Color manipulation
    • 2. Detail refinement
    • 3. Load/export configuration
    • 4. Curves
    • 5. Dynamic range
    • 6. GPU accelerating
    • 7. Save 12-bits image
    • 8. Exposure masking
    • 12. Sharpness metric
  • Linux Troubleshooting
  • C# Memory Handling
  • Glossary
Back to top

PropertyValue Class#

Definition#

Namespace: P1.CameraSdk

Hold a single property value, and acts like a union of different property types More…

public class PropertyValue :  IEquatable< PropertyValue >

Remarks#

Hold a single property value, and acts like a union of different property types

Constructors#

PropertyValue(PropertyType type)

Properties#

Type

IntValue

FloatValue

StringValue

PointValue

ColorValue

AreaValue

AreaFloatValue

RectValue

RangeValue

RangeFloatValue

PresentationString

IconId

Methods#

GetHashCode()

Equals(object o)

Equals(PropertyValue another)

ToString()

Returns a simple string representation of this property

operator==(PropertyValue a, PropertyValue b)

operator!=(PropertyValue a, PropertyValue b)

operator PropertyValue(System.Enum e)

operator PropertyValue(bool v)

operator PropertyValue(Int32 v)

operator PropertyValue(Int64 v)

operator PropertyValue(UInt32 v)

operator PropertyValue(UInt64 v)

operator PropertyValue(double v)

operator PropertyValue(string v)

operator bool(PropertyValue p)

operator Int32(PropertyValue p)

operator Int64(PropertyValue p)

operator UInt32(PropertyValue p)

operator UInt64(PropertyValue p)

operator double(PropertyValue p)

operator string(PropertyValue p)

Next
PropertyValue Constructor
Previous
PropertySpec.ToString Method
Copyright © 2025, Phase One A/S - Revision: 4.1.16, CamSdk: 3.1.8, ImgSdk 4.1.57
Made with Sphinx and @pradyunsg's Furo
On this page
  • PropertyValue Class
    • Definition
    • Remarks
    • Constructors
    • Properties
    • Methods