IMcStream Properties |
|
The IMcStream type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Artist | This is a shortcut to the Artist TIFF Tag, but it can also
be used by other formats to retrieve information about the ownner of an image file.
If there is no Author, an empty BSTR will be returned. |
| Attributes | Gets a pointer to the McStreamAttributes Collection |
| BestFitMode | This property determines whether to apply a best-fit display range to the image after it
is opened. |
| BitDepth | Returns the number of bits each channel occupies. |
| Channels | Gets or Sets the Channels property in the image file.
Usually 1 (Monochrome) or 3 (RGB,HSI, etc). |
| ColorSpace | Returns a String that indicates which colorspace the image data is in
HSI, HSV, Yuv, YCC, RGB, Monochrome, etc.... |
| Comments | This is a shortcut to the Comments TIFF Tag, but it can also
be used by other formats to retrieve extended comments out of an image file.
If there are no Comments, an empty String will be returned. |
| Compression | Gets/Sets the compression used for this image file. |
| CurrentFrame | The Current Frame that will be read. |
| DataTypeString | Returns a textual string describing the Number of Bytes per pixel the image is in.
Typical return values are "Unsigned Char", "Float", "Unsigned Short", etc.... |
| DateTime | If the file format supports an internal Date and Time value (such as TIFF),
then this information is used. If there is no support, the file sytems
date/time information is returned. |
| Destination | Gets or Sets the VARIANT with the pathname or object that is the destination
for writing an image, if this is a writing stream. If it is a reading
stream, the destination is usually an IMcImage object that will contain
the data and image information |
| EndFrame | The last frame to read. |
 | FileName | On Get, fills the String parameter with the name of the file
that is being used as the Source (reading) or Destination (writing)
If the Source/Destination is actually an Istream/IStorage, then the
name of that particular IStream/IStorage is returned. If there is no
FileName set, an empty String is returned.
This property is generated from the FullPathName. The FileName differs in that
it is only the name of the image and the extension, but does not include any qualifying
directory names. |
| Flags | Gets/Sets any defined flags for the McStream. |
| Format | Gets or Sets the String Format with the file format descriptor string
that is used to create the Helper Subclass.
If this property is Set, the Helper Subclass is created. |
| FormatCharacteristics | Read-only property indicating the characteristics and capabilities of the selected
file format. |
| FrameRange | To Read non-contiguous frames out of a sequence, pass a SAFEARRAY
filled with the 0-based frame numbers you wish to read to this property |
| FullPathName | This property returns the fully qualified path of the file
that is being used as the Source (reading) or Destination (writing)
On Set, Sets the internal property to the String passed. |
| Height | On Get, Fills the long parameter with the height of the image read
from the image file.
On Set, sets the local property to the long value
The Height is determined by the number of Pixels from OriginY to the bottom
of the image. The Height must be less than or equal to the Height of the
File data.
If you wish to Subsample the image, see PreviewHeight. |
| IsLossy | Read-only property reporting whether the selected file format/compression combination
may be lossy (see Remarks). |
| IsMemoryFile | If this file is being read from disk, the return is False. If it
is a virtual image, usually created by a filter or other type,
the return is True. |
| IsMovie | Returns whether this image file is a sequence (or movie). |
| IsOpen | |
| LineSize | Returns the total number of bytes that make up 1 line of the image.
Usually computed by (Width - OriginX) * Channels * sizeof(datatype) |
| LoadMethod | McStream can load all frames of a sequence at once into memory (the default),
or a single frame at a time via this method.
It will be one of these enumerated values:
mcLoadAllFrames
mcLoadSingleFrame |
| LoadStatus | A read-only property that returns an mcslsLoadStatus value indicating the status of
the previously Read image file. |
| MultipleResolution | Read-only property reporting whether the selected file includes multiple resolutions. |
| OriginX | Gets or Sets the horizontal integer offset for the beginning of a subsectional
valid area of the data. This defaults to 0 (left-most pixel). Setting this
value allows only saving/loading a section of an image. |
| OriginY | Retrieves the vertical integer offset for the beginning of a subsectional
valid area of the data. This defaults to 0. Setting this value allows
only saving/loading a section of an image. |
| PreviewHeight | Read-only property that gives the Height of the previewed image,
determined by the sub-sampled image height minus any fill. |
| PreviewMode | |
| PreviewWidth | Read-only property that gives the Width of the previewed image,
determined by the sub-sampled image width minus any fill. |
| RangeMax | Read-Only property to access the Maximum clipping range that
was identified in an image file. |
| RangeMin | Read-Only property to access the Minimum clipping range that
was identified in an image file. |
| ReadOnly | Returns a Boolean value that indicates whether the McStream
is able to be Written to. Many factors can affect this status, such as
support for a writable McStream Format, the current File's Permissions,
Licensing, etc.... True means the file cannot be Written, False means the file
may be Written. |
| ReadWriteMode | Gets/Sets the file access mode, for reading or for writing. Not all formats
are supported for writing. |
| Resolution | This read/write property determines the image resolution that will be opened. |
| ResolutionSizes | Read-only property returning a list of resolution descriptions. |
| ShowProgressMeter | Gets or Sets a Boolean value that indicates whether the McStream
library should update a Progress Bar during operations. Default is True,
meaning to update the progress bar. |
| SizeOfDataType | Returns the number of bytes for each of the image file's pixels. |
| Software | Read-Only property used to access an indicator in some image files that
identifies which software was used to create this image file. |
| Source | Gets or Sets the VARIANT with the pathname or object that is the source
for writing an image, such as an McImage object, if this is a writing stream.
If it is a reading stream, the source is usually a Filename
that will contain the data and image information |
| StartFrame | The first frame to read. |
| StorageSize | Property to determine the size, in bytes, of the complete file. Notice that
this may be larger or smaller than the image size due to Compression and/or
the File Format's structure. |
| SubClass | Returns the file format specific class |
| TagValue | |
| Title | Returns the Title (if any) in the Image File as a BSTR. |
| TotalFrames | Total frames read or to be written. |
| WarningLevel | Gets/Sets the level of Feedback the Stream library will provide. |
| Width | Gets or Sets the Width property.
Width indicates the number of Pixel columns from the left (originX) of the image. |
See Also