DpxHeader Class
The fields of the headers of a DPX file (SMPTE ST 268) that describe its first image element and where it comes from. This is informational only, like ImageMetadata.SourceFormat: it describes the file, not the pixels.
public sealed class DpxHeader : IEquatable<DpxHeader>Remarks
Nothing is applied to the pixels: they are the code values the file stores, scaled to the sample range of the pixel format. DpxHeader.Transfer says how they encode light (a logarithmic film scan, linear light, a video signal); a conversion to linear light is an explicit operation of the caller.
A field the file leaves undefined (the "undefined" value of its type, all bits set for numbers and an empty string for text) is null. No operation updates it, and every encoder ignores it: DpxEncoder writes the fields it derives from the image itself.
- Implements
Constructors
| Name | Description |
|---|---|
| DpxHeader() |
DpxHeader()
DpxHeader.cspublic DpxHeader()No documentation is available.
Properties
| Name | Description |
|---|---|
| BitDepth | Gets the number of bits of each component: 1, 8, 10, 12 or 16 (integers), 32 or 64 (floating point). |
| Colorimetric | Gets the colorimetric specification (the primaries or the color responses) of the code values. |
| Copyright | Gets the right-to-use or copyright statement, or null. |
| CreationTime | Gets the creation date and time (yyyy:mm:dd:hh:mm:ssLTZ, as the file stores it), or null. |
| Creator | Gets the creator (the program that wrote the file), or null. |
| Descriptor | Gets the components of the first image element. |
| ElementDescription | Gets the description of the first image element, or null. |
| FieldNumber | Gets the field number of the first field, or null. |
| FileName | Gets the file name recorded in the header, or null. |
| FilmEdgeCode | Gets the film edge code (SMPTE ST 254): the manufacturer identification, the film type, the offset in perforations, the prefix and the count, 16 digits as the file stores them, or null without a motion-picture film header or when one of its parts is undefined. |
| FilmFormat | Gets the film format, such as Academy, or null. |
| FrameIdentification | Gets the frame identification (such as a key frame), or null. |
| FramePosition | Gets the position of the frame in its sequence, or null. |
| FrameRate | Gets the frame rate of the original film, in frames per second, or null. |
| Gamma | Gets the gamma of the television header (the exponent of Y = X^(1/gamma)), or null. It is never applied. |
| HeldCount | Gets the number of frames for which to hold this frame, or null. |
| ImageElementCount | Gets the number of image elements of the file (1 to 8). Only the first one is decoded. |
| InputDevice | Gets the name of the input device, or null. |
| InputDeviceSerialNumber | Gets the serial number of the input device, or null. |
| IsBigEndian | Gets a value indicating whether the file is big-endian (magic number SDPX) rather than little-endian (XPDS). |
| IsInterlaced | Gets a value indicating whether the signal is 2:1 interlaced, or null. |
| Packing | Gets how the components are packed into 32-bit words. |
| Project | Gets the project name, or null. |
| ReferenceHighCode | Gets the code value of the reference high quantity (the maximum expected code value), or null. |
| ReferenceHighQuantity | Gets the signal level or measured value the reference high code value represents, such as a density of 2.048, or null. |
| ReferenceLowCode | Gets the code value of the reference low quantity (the minimum expected code value), or null. |
| ReferenceLowQuantity | Gets the signal level or measured value the reference low code value represents, or null. |
| SequenceLength | Gets the number of frames of the sequence, or null. |
| ShutterAngle | Gets the shutter angle of the camera, in degrees, or null. |
| SlateInformation | Gets the slate information, or null. |
| SourceCreationTime | Gets the creation date and time of the source image, as the file stores it, or null. |
| SourceFileName | Gets the file name of the source image, or null. |
| TemporalSamplingRate | Gets the temporal sampling rate (the frame rate) of the television header, in hertz, or null. |
| TimeCode | Gets the SMPTE time code of the television header (SMPTE ST 12-1, Table 6) as hh:mm:ss:ff, or null without a television header or when it is undefined or its digits are not decimal. |
| Transfer | Gets the transfer characteristic of the code values. It is never applied. |
| UserBits | Gets the SMPTE user bits of the television header, or null. |
| Version | Gets the version of the header format, such as V2.0 or V1.0. |
| VideoSignalStandard | Gets the video signal standard (SMPTE ST 268, Table 4), or null. |
BitDepth
DpxHeader.csColorimetric
DpxHeader.csGets the colorimetric specification (the primaries or the color responses) of the code values.
public DpxColorimetricSpecification Colorimetric { get; init; }Property value
Copyright
DpxHeader.csCreationTime
DpxHeader.csCreator
DpxHeader.csDescriptor
DpxHeader.csGets the components of the first image element.
public DpxDescriptor Descriptor { get; init; }Property value
ElementDescription
DpxHeader.csFieldNumber
DpxHeader.csFileName
DpxHeader.csFilmEdgeCode
DpxHeader.csGets the film edge code (SMPTE ST 254): the manufacturer identification, the film type, the offset in perforations, the prefix and the count, 16 digits as the file stores them, or null without a motion-picture film header or when one of its parts is undefined.
public string? FilmEdgeCode { get; init; }Property value
FilmFormat
DpxHeader.csFrameIdentification
DpxHeader.csFramePosition
DpxHeader.csFrameRate
DpxHeader.csGamma
DpxHeader.csHeldCount
DpxHeader.csImageElementCount
DpxHeader.csInputDevice
DpxHeader.csInputDeviceSerialNumber
DpxHeader.csIsBigEndian
DpxHeader.csIsInterlaced
DpxHeader.csPacking
DpxHeader.csGets how the components are packed into 32-bit words.
public DpxPacking Packing { get; init; }Property value
Project
DpxHeader.csReferenceHighCode
DpxHeader.csReferenceHighQuantity
DpxHeader.csReferenceLowCode
DpxHeader.csReferenceLowQuantity
DpxHeader.csSequenceLength
DpxHeader.csShutterAngle
DpxHeader.csSlateInformation
DpxHeader.csSourceCreationTime
DpxHeader.csSourceFileName
DpxHeader.csTemporalSamplingRate
DpxHeader.csTimeCode
DpxHeader.csTransfer
DpxHeader.csGets the transfer characteristic of the code values. It is never applied.
public DpxTransferCharacteristic Transfer { get; init; }Property value
UserBits
DpxHeader.csVersion
DpxHeader.csVideoSignalStandard
DpxHeader.csMethods
| Name | Description |
|---|---|
| Equals(DpxHeader?) | Indicates whether the current object is equal to another object of the same type. |
| Equals(object?) | Determines whether the specified object is equal to the current object. |
| GetHashCode() | Serves as the default hash function. |
| ToString() | Returns a string that represents the current object. |
Equals overloads
Equals(DpxHeader?)
DpxHeader.csIndicates whether the current object is equal to another object of the same type.
Parameters
otherDpxHeader?- An object to compare with this object.
Returns
bool true if the current object is equal to the other parameter; otherwise, false.