TIFFFileDirectory

Objective-C

@interface TIFFFileDirectory : NSObject

Swift

class TIFFFileDirectory : NSObject

File Directory, represents all directory entries and can be used to read the image raster

Show on GitHub

  • Rasters to write to the TIFF file

    Declaration

    Objective-C

    @property (nonatomic, strong) TIFFRasters *writeRasters;

    Swift

    var writeRasters: TIFFRasters! { get set }
    Show on GitHub

  • Initialize, for reading TIFF files

    Declaration

    Objective-C

    - (instancetype)initWithEntries:
                    (NSMutableOrderedSet<TIFFFileDirectoryEntry *> *)entries
                      andReader:(TIFFByteReader *)reader;

    Swift

    init!(entries: NSMutableOrderedSet!, andReader reader: TIFFByteReader!)

    Parameters

    entries

    file directory entries
    reader

    TIFF file byte reader
    Show on GitHub

  • Initialize, for reading TIFF files

    Declaration

    Objective-C

    - (instancetype)initWithEntries:
                    (NSMutableOrderedSet<TIFFFileDirectoryEntry *> *)entries
                      andReader:(TIFFByteReader *)reader
                   andCacheData:(BOOL)cacheData;

    Swift

    init!(entries: NSMutableOrderedSet!, andReader reader: TIFFByteReader!, andCacheData cacheData: Bool)

    Parameters

    entries

    file directory entries
    reader

    TIFF file byte reader
    cacheData

    true to cache tiles and strips
    Show on GitHub

  • Constructor, for writing TIFF files

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()
    Show on GitHub

  • Constructor, for writing TIFF files

    Declaration

    Objective-C

    - (instancetype)initWithRasters:(TIFFRasters *)rasters;

    Swift

    init!(rasters: TIFFRasters!)

    Parameters

    rasters

    image rasters to write
    Show on GitHub

  • Constructor, for writing TIFF files

    Declaration

    Objective-C

    - (instancetype)initWithEntries:
                    (NSMutableOrderedSet<TIFFFileDirectoryEntry *> *)entries
                     andRasters:(TIFFRasters *)rasters;

    Swift

    init!(entries: NSMutableOrderedSet!, andRasters rasters: TIFFRasters!)

    Parameters

    entries

    file directory entries
    rasters

    image rasters to write
    Show on GitHub

  • Add an entry

    Declaration

    Objective-C

    - (void)addEntry:(TIFFFileDirectoryEntry *)entry;

    Swift

    func addEntry(_ entry: TIFFFileDirectoryEntry!)

    Parameters

    entry

    file directory entry
    Show on GitHub

  • Set whether to cache tiles. Does nothing is already caching tiles, clears the existing cache if set to false.

    Declaration

    Objective-C

    - (void)setCacheData:(BOOL)cacheData;

    Swift

    func setCacheData(_ cacheData: Bool)

    Parameters

    cacheData

    true to cache tiles and strips
    Show on GitHub

  • Get the byte reader

    Declaration

    Objective-C

    - (TIFFByteReader *)reader;

    Swift

    func reader() -> TIFFByteReader!

    Return Value

    byte reader

    Show on GitHub

  • Is this a tiled image

    Declaration

    Objective-C

    - (BOOL)isTiled;

    Swift

    func isTiled() -> Bool

    Return Value

    true if tiled

    Show on GitHub

  • Get the compression decoder

    Declaration

    Objective-C

    - (NSObject<TIFFCompressionDecoder> *)decoder;

    Swift

    func decoder() -> TIFFCompressionDecoder!

    Return Value

    compression decoder

    Show on GitHub

  • Get the number of entries

    Declaration

    Objective-C

    - (int)numEntries;

    Swift

    func numEntries() -> Int32

    Return Value

    entry count

    Show on GitHub

  • Get a file directory entry from the field tag type

    Declaration

    Objective-C

    - (TIFFFileDirectoryEntry *)entryByFieldTagType:
    (enum TIFFFieldTagType)fieldTagType;

    Swift

    func entry(by fieldTagType: TIFFFieldTagType) -> TIFFFileDirectoryEntry!

    Parameters

    fieldTagType

    field tag type

    Return Value

    file directory entry

    Show on GitHub

  • Get the file directory entries

    Declaration

    Objective-C

    - (NSOrderedSet<TIFFFileDirectoryEntry *> *)entries;

    Swift

    func entries() -> NSOrderedSet!

    Return Value

    file directory entries

    Show on GitHub

  • Get the field tag type to file directory entry mapping

    Declaration

    Objective-C

    - (NSDictionary<NSNumber *, TIFFFileDirectoryEntry *> *)fieldTagTypeMapping;

    Swift

    func fieldTagTypeMapping() -> [NSNumber : TIFFFileDirectoryEntry]!

    Return Value

    field tag type mapping

    Show on GitHub

  • Get the image width

    Declaration

    Objective-C

    - (NSNumber *)imageWidth;

    Swift

    func imageWidth() -> NSNumber!

    Return Value

    image width

    Show on GitHub

  • Set the image width

    Declaration

    Objective-C

    - (void)setImageWidth:(unsigned short)width;

    Swift

    func setImageWidth(_ width: UInt16)

    Parameters

    width

    image width
    Show on GitHub

  • Set the image width

    Declaration

    Objective-C

    - (void)setImageWidthAsLong:(unsigned long)width;

    Swift

    func setImageWidthAsLong(_ width: UInt)

    Parameters

    width

    image width
    Show on GitHub

  • Get the image height

    Declaration

    Objective-C

    - (NSNumber *)imageHeight;

    Swift

    func imageHeight() -> NSNumber!

    Return Value

    image height

    Show on GitHub

  • Set the image height

    Declaration

    Objective-C

    - (void)setImageHeight:(unsigned short)height;

    Swift

    func setImageHeight(_ height: UInt16)

    Parameters

    height

    image height
    Show on GitHub

  • Set the image height

    Declaration

    Objective-C

    - (void)setImageHeightAsLong:(unsigned long)height;

    Swift

    func setImageHeightAsLong(_ height: UInt)

    Parameters

    height

    image height
    Show on GitHub

  • Get the bits per sample

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)bitsPerSample;

    Swift

    func bitsPerSample() -> [NSNumber]!

    Return Value

    bits per sample

    Show on GitHub

  • Set the bits per sample

    Declaration

    Objective-C

    - (void)setBitsPerSample:(NSArray<NSNumber *> *)bitsPerSample;

    Swift

    func setBitsPerSample(_ bitsPerSample: [NSNumber]!)

    Parameters

    bitsPerSample

    bits per sample
    Show on GitHub

  • Set a single value bits per sample

    Declaration

    Objective-C

    - (void)setBitsPerSampleAsSingleValue:(unsigned short)bitsPerSample;

    Swift

    func setBitsPerSampleAsSingleValue(_ bitsPerSample: UInt16)

    Parameters

    bitsPerSample

    bits per sample
    Show on GitHub

  • Get the max bits per sample

    Declaration

    Objective-C

    - (NSNumber *)maxBitsPerSample;

    Swift

    func maxBitsPerSample() -> NSNumber!

    Return Value

    max bits per sample

    Show on GitHub

  • Get the compression

    Declaration

    Objective-C

    - (NSNumber *)compression;

    Swift

    func compression() -> NSNumber!

    Return Value

    compression

    Show on GitHub

  • Set the compression

    Declaration

    Objective-C

    - (void)setCompression:(unsigned short)compression;

    Swift

    func setCompression(_ compression: UInt16)

    Parameters

    compression

    compression
    Show on GitHub

  • Get the photometric interpretation

    Declaration

    Objective-C

    - (NSNumber *)photometricInterpretation;

    Swift

    func photometricInterpretation() -> NSNumber!

    Return Value

    photometric interpretation

    Show on GitHub

  • Set the photometric interpretation

    Declaration

    Objective-C

    - (void)setPhotometricInterpretation:(unsigned short)photometricInterpretation;

    Swift

    func setPhotometricInterpretation(_ photometricInterpretation: UInt16)

    Parameters

    photometricInterpretation

    photometric interpretation
    Show on GitHub

  • Get the strip offsets

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)stripOffsets;

    Swift

    func stripOffsets() -> [NSNumber]!

    Return Value

    strip offsets

    Show on GitHub

  • Set the strip offsets

    Declaration

    Objective-C

    - (void)setStripOffsets:(NSArray<NSNumber *> *)stripOffsets;

    Swift

    func setStripOffsets(_ stripOffsets: [NSNumber]!)

    Parameters

    stripOffsets

    strip offsets
    Show on GitHub

  • Set the strip offsets

    Declaration

    Objective-C

    - (void)setStripOffsetsAsLongs:(NSArray<NSNumber *> *)stripOffsets;

    Swift

    func setStripOffsetsAsLongs(_ stripOffsets: [NSNumber]!)

    Parameters

    stripOffsets

    strip offsets
    Show on GitHub

  • Set a single value strip offset

    Declaration

    Objective-C

    - (void)setStripOffsetsAsSingleValue:(unsigned short)stripOffset;

    Swift

    func setStripOffsetsAsSingleValue(_ stripOffset: UInt16)

    Parameters

    stripOffset

    strip offset
    Show on GitHub

  • Set a single value strip offset

    Declaration

    Objective-C

    - (void)setStripOffsetsAsSingleLongValue:(unsigned long)stripOffset;

    Swift

    func setStripOffsetsAsSingleLongValue(_ stripOffset: UInt)

    Parameters

    stripOffset

    strip offset
    Show on GitHub

  • Get the samples per pixel

    Declaration

    Objective-C

    - (int)samplesPerPixel;

    Swift

    func samplesPerPixel() -> Int32

    Return Value

    samples per pixel

    Show on GitHub

  • Set the samples per pixel

    Declaration

    Objective-C

    - (void)setSamplesPerPixel:(unsigned short)samplesPerPixel;

    Swift

    func setSamplesPerPixel(_ samplesPerPixel: UInt16)

    Parameters

    samplesPerPixel

    samples per pixel
    Show on GitHub

  • Get the rows per strip

    Declaration

    Objective-C

    - (NSNumber *)rowsPerStrip;

    Swift

    func rowsPerStrip() -> NSNumber!

    Return Value

    rows per strip

    Show on GitHub

  • Set the rows per strip

    Declaration

    Objective-C

    - (void)setRowsPerStrip:(unsigned short)rowsPerStrip;

    Swift

    func setRowsPerStrip(_ rowsPerStrip: UInt16)

    Parameters

    rowsPerStrip

    rows per strip
    Show on GitHub

  • Set the rows per strip

    Declaration

    Objective-C

    - (void)setRowsPerStripAsLong:(unsigned long)rowsPerStrip;

    Swift

    func setRowsPerStripAsLong(_ rowsPerStrip: UInt)

    Parameters

    rowsPerStrip

    rows per strip
    Show on GitHub

  • Get the strip byte counts

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)stripByteCounts;

    Swift

    func stripByteCounts() -> [NSNumber]!

    Return Value

    strip byte counts

    Show on GitHub

  • Set the strip byte counts

    Declaration

    Objective-C

    - (void)setStripByteCounts:(NSArray<NSNumber *> *)stripByteCounts;

    Swift

    func setStripByteCounts(_ stripByteCounts: [NSNumber]!)

    Parameters

    stripByteCounts

    strip byte counts
    Show on GitHub

  • Set the strip byte counts

    Declaration

    Objective-C

    - (void)setStripByteCountsAsLongs:(NSArray<NSNumber *> *)stripByteCounts;

    Swift

    func setStripByteCountsAsLongs(_ stripByteCounts: [NSNumber]!)

    Parameters

    stripByteCounts

    strip byte counts
    Show on GitHub

  • Set a single value strip byte count

    Declaration

    Objective-C

    - (void)setStripByteCountsAsSingleValue:(unsigned short)stripByteCount;

    Swift

    func setStripByteCountsAsSingleValue(_ stripByteCount: UInt16)

    Parameters

    stripByteCount

    strip byte count
    Show on GitHub

  • Set a single value strip byte count

    Declaration

    Objective-C

    - (void)setStripByteCountsAsSingleLongValue:(unsigned long)stripByteCount;

    Swift

    func setStripByteCountsAsSingleLongValue(_ stripByteCount: UInt)

    Parameters

    stripByteCount

    strip byte count
    Show on GitHub

  • Get the x resolution

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)xResolution;

    Swift

    func xResolution() -> [NSNumber]!

    Return Value

    x resolution

    Show on GitHub

  • Set the x resolution

    Declaration

    Objective-C

    - (void)setXResolution:(NSArray<NSNumber *> *)xResolution;

    Swift

    func setXResolution(_ xResolution: [NSNumber]!)

    Parameters

    xResolution

    x resolution
    Show on GitHub

  • Set a single value x resolution

    Declaration

    Objective-C

    - (void)setXResolutionAsSingleValue:(unsigned long)xResolution;

    Swift

    func setXResolutionAsSingleValue(_ xResolution: UInt)

    Parameters

    xResolution

    x resolution
    Show on GitHub

  • Get the y resolution

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)yResolution;

    Swift

    func yResolution() -> [NSNumber]!

    Return Value

    y resolution

    Show on GitHub

  • Set the y resolution

    Declaration

    Objective-C

    - (void)setYResolution:(NSArray<NSNumber *> *)yResolution;

    Swift

    func setYResolution(_ yResolution: [NSNumber]!)

    Parameters

    yResolution

    y resolution
    Show on GitHub

  • Set a single value y resolution

    Declaration

    Objective-C

    - (void)setYResolutionAsSingleValue:(unsigned long)yResolution;

    Swift

    func setYResolutionAsSingleValue(_ yResolution: UInt)

    Parameters

    yResolution

    y resolution
    Show on GitHub

  • Get the planar configuration

    Declaration

    Objective-C

    - (NSNumber *)planarConfiguration;

    Swift

    func planarConfiguration() -> NSNumber!

    Return Value

    planar configuration

    Show on GitHub

  • Set the planar configuration

    Declaration

    Objective-C

    - (void)setPlanarConfiguration:(unsigned short)planarConfiguration;

    Swift

    func setPlanarConfiguration(_ planarConfiguration: UInt16)

    Parameters

    planarConfiguration

    planar configuration
    Show on GitHub

  • Get the resolution unit

    Declaration

    Objective-C

    - (NSNumber *)resolutionUnit;

    Swift

    func resolutionUnit() -> NSNumber!

    Return Value

    resolution unit

    Show on GitHub

  • Set the resolution unit

    Declaration

    Objective-C

    - (void)setResolutionUnit:(unsigned short)resolutionUnit;

    Swift

    func setResolutionUnit(_ resolutionUnit: UInt16)

    Parameters

    resolutionUnit

    resolution unit
    Show on GitHub

  • Get the model pixel scale

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)modelPixelScale;

    Swift

    func modelPixelScale() -> [NSNumber]!

    Return Value

    model pixel scale

    Show on GitHub

  • Set the model pixel scale

    Declaration

    Objective-C

    - (void)setModelPixelScale:(NSArray<NSNumber *> *)modelPixelScale;

    Swift

    func setModelPixelScale(_ modelPixelScale: [NSNumber]!)

    Parameters

    modelPixelScale

    pixel scale
    Show on GitHub

  • Get the model tiepoint

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)modelTiepoint;

    Swift

    func modelTiepoint() -> [NSNumber]!

    Return Value

    model tiepoint

    Show on GitHub

  • Set the model tiepoint

    Declaration

    Objective-C

    - (void)setModelTiepoint:(NSArray<NSNumber *> *)modelTiepoint;

    Swift

    func setModelTiepoint(_ modelTiepoint: [NSNumber]!)

    Parameters

    modelTiepoint

    model tiepoint
    Show on GitHub

  • Get the color map

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)colorMap;

    Swift

    func colorMap() -> [NSNumber]!

    Return Value

    color map

    Show on GitHub

  • Set the color map

    Declaration

    Objective-C

    - (void)setColorMap:(NSArray<NSNumber *> *)colorMap;

    Swift

    func setColorMap(_ colorMap: [NSNumber]!)

    Parameters

    colorMap

    color map
    Show on GitHub

  • Set a single value color map

    Declaration

    Objective-C

    - (void)setColorMapAsSingleValue:(unsigned short)colorMap;

    Swift

    func setColorMapAsSingleValue(_ colorMap: UInt16)

    Parameters

    colorMap

    color map
    Show on GitHub

  • Get the tile width

    Declaration

    Objective-C

    - (NSNumber *)tileWidth;

    Swift

    func tileWidth() -> NSNumber!

    Return Value

    tile width

    Show on GitHub

  • Set the tile width

    Declaration

    Objective-C

    - (void)setTileWidth:(unsigned short)tileWidth;

    Swift

    func setTileWidth(_ tileWidth: UInt16)

    Parameters

    tileWidth

    tile width
    Show on GitHub

  • Set the tile width

    Declaration

    Objective-C

    - (void)setTileWidthAsLong:(unsigned long)tileWidth;

    Swift

    func setTileWidthAsLong(_ tileWidth: UInt)

    Parameters

    tileWidth

    tile width
    Show on GitHub

  • Get the tile height

    Declaration

    Objective-C

    - (NSNumber *)tileHeight;

    Swift

    func tileHeight() -> NSNumber!

    Return Value

    tile height

    Show on GitHub

  • Set the tile height

    Declaration

    Objective-C

    - (void)setTileHeight:(unsigned short)tileHeight;

    Swift

    func setTileHeight(_ tileHeight: UInt16)

    Parameters

    tileHeight

    tile width
    Show on GitHub

  • Set the tile height

    Declaration

    Objective-C

    - (void)setTileHeightAsLong:(unsigned long)tileHeight;

    Swift

    func setTileHeightAsLong(_ tileHeight: UInt)

    Parameters

    tileHeight

    tile height
    Show on GitHub

  • Get the tile offsets

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)tileOffsets;

    Swift

    func tileOffsets() -> [NSNumber]!

    Return Value

    tile offsets

    Show on GitHub

  • Set the tile offsets

    Declaration

    Objective-C

    - (void)setTileOffsets:(NSArray<NSNumber *> *)tileOffsets;

    Swift

    func setTileOffsets(_ tileOffsets: [NSNumber]!)

    Parameters

    tileOffsets

    tile offsets
    Show on GitHub

  • Set a single value tile offset

    Declaration

    Objective-C

    - (void)setTileOffsetsAsSingleValue:(unsigned short)tileOffset;

    Swift

    func setTileOffsetsAsSingleValue(_ tileOffset: UInt16)

    Parameters

    tileOffset

    tile offset
    Show on GitHub

  • Get the tile byte counts

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)tileByteCounts;

    Swift

    func tileByteCounts() -> [NSNumber]!

    Return Value

    tile byte counts

    Show on GitHub

  • Set the tile byte counts

    Declaration

    Objective-C

    - (void)setTileByteCounts:(NSArray<NSNumber *> *)tileByteCounts;

    Swift

    func setTileByteCounts(_ tileByteCounts: [NSNumber]!)

    Parameters

    tileByteCounts

    tile byte counts
    Show on GitHub

  • Set the tile byte counts

    Declaration

    Objective-C

    - (void)setTileByteCountsAsLongs:(NSArray<NSNumber *> *)tileByteCounts;

    Swift

    func setTileByteCountsAsLongs(_ tileByteCounts: [NSNumber]!)

    Parameters

    tileByteCounts

    tile byte counts
    Show on GitHub

  • Set a single value tile byte count

    Declaration

    Objective-C

    - (void)setTileByteCountsAsSingleValue:(unsigned short)tileByteCount;

    Swift

    func setTileByteCountsAsSingleValue(_ tileByteCount: UInt16)

    Parameters

    tileByteCount

    tile byte count
    Show on GitHub

  • Set a single value tile byte count

    Declaration

    Objective-C

    - (void)setTileByteCountsAsSingleLongValue:(unsigned long)tileByteCount;

    Swift

    func setTileByteCountsAsSingleLongValue(_ tileByteCount: UInt)

    Parameters

    tileByteCount

    tile byte count
    Show on GitHub

  • Get the sample format

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)sampleFormat;

    Swift

    func sampleFormat() -> [NSNumber]!

    Return Value

    sample format

    Show on GitHub

  • Set the sample format

    Declaration

    Objective-C

    - (void)setSampleFormat:(NSArray<NSNumber *> *)sampleFormat;

    Swift

    func setSampleFormat(_ sampleFormat: [NSNumber]!)

    Parameters

    sampleFormat

    sample format
    Show on GitHub

  • Set a single value sample format

    Declaration

    Objective-C

    - (void)setSampleFormatAsSingleValue:(unsigned short)sampleFormat;

    Swift

    func setSampleFormatAsSingleValue(_ sampleFormat: UInt16)

    Parameters

    sampleFormat

    sample format
    Show on GitHub

  • Get the max sample format

    Declaration

    Objective-C

    - (NSNumber *)maxSampleFormat;

    Swift

    func maxSampleFormat() -> NSNumber!

    Return Value

    max sample format

    Show on GitHub

  • Get the predictor

    Declaration

    Objective-C

    - (NSNumber *)predictor;

    Swift

    func predictor() -> NSNumber!

    Return Value

    predictor

    Show on GitHub

  • Set the predictor

    Declaration

    Objective-C

    - (void)setPredictor:(unsigned short)predictor;

    Swift

    func setPredictor(_ predictor: UInt16)

    Parameters

    predictor

    predictor
    Show on GitHub

  • Read the rasters

    Declaration

    Objective-C

    - (TIFFRasters *)readRasters;

    Swift

    func readRasters() -> TIFFRasters!

    Return Value

    rasters

    Show on GitHub

  • Read the rasters as interleaved

    Declaration

    Objective-C

    - (TIFFRasters *)readInterleavedRasters;

    Swift

    func readInterleavedRasters() -> TIFFRasters!

    Return Value

    rasters

    Show on GitHub

  • Read the rasters

    Declaration

    Objective-C

    - (TIFFRasters *)readRastersWithWindow:(TIFFImageWindow *)window;

    Swift

    func readRasters(with window: TIFFImageWindow!) -> TIFFRasters!

    Parameters

    window

    image window

    Return Value

    rasters

    Show on GitHub

  • Read the rasters as interleaved

    Declaration

    Objective-C

    - (TIFFRasters *)readInterleavedRastersWithWindow:(TIFFImageWindow *)window;

    Swift

    func readInterleavedRasters(with window: TIFFImageWindow!) -> TIFFRasters!

    Parameters

    window

    image window

    Return Value

    rasters

    Show on GitHub

  • Read the rasters

    Declaration

    Objective-C

    - (TIFFRasters *)readRastersWithSamples:(NSArray<NSNumber *> *)samples;

    Swift

    func readRasters(withSamples samples: [NSNumber]!) -> TIFFRasters!

    Parameters

    samples

    pixel samples to read

    Return Value

    rasters

    Show on GitHub

  • Read the rasters as interleaved

    Declaration

    Objective-C

    - (TIFFRasters *)readInterleavedRastersWithSamples:
    (NSArray<NSNumber *> *)samples;

    Swift

    func readInterleavedRasters(withSamples samples: [NSNumber]!) -> TIFFRasters!

    Parameters

    samples

    pixel samples to read

    Return Value

    rasters

    Show on GitHub

  • Read the rasters

    Declaration

    Objective-C

    - (TIFFRasters *)readRastersWithWindow:(TIFFImageWindow *)window
                            andSamples:(NSArray<NSNumber *> *)samples;

    Swift

    func readRasters(with window: TIFFImageWindow!, andSamples samples: [NSNumber]!) -> TIFFRasters!

    Parameters

    window

    image window
    samples

    pixel samples to read

    Return Value

    rasters

    Show on GitHub

  • Read the rasters as interleaved

    Declaration

    Objective-C

    - (TIFFRasters *)readInterleavedRastersWithWindow:(TIFFImageWindow *)window
                                       andSamples:
                                           (NSArray<NSNumber *> *)samples;

    Swift

    func readInterleavedRasters(with window: TIFFImageWindow!, andSamples samples: [NSNumber]!) -> TIFFRasters!

    Parameters

    window

    image window
    samples

    pixel samples to read

    Return Value

    rasters

    Show on GitHub

  • Read the rasters

    Declaration

    Objective-C

    - (TIFFRasters *)readRastersWithSampleValues:(BOOL)sampleValues
                         andInterleaveValues:(BOOL)interleaveValues;

    Swift

    func readRasters(withSampleValues sampleValues: Bool, andInterleaveValues interleaveValues: Bool) -> TIFFRasters!

    Parameters

    sampleValues

    true to read results per sample
    interleaveValues

    true to read results as interleaved

    Return Value

    rasters

    Show on GitHub

  • Read the rasters

    Declaration

    Objective-C

    - (TIFFRasters *)readRastersWithWindow:(TIFFImageWindow *)window
                       andSampleValues:(BOOL)sampleValues
                   andInterleaveValues:(BOOL)interleaveValues;

    Swift

    func readRasters(with window: TIFFImageWindow!, andSampleValues sampleValues: Bool, andInterleaveValues interleaveValues: Bool) -> TIFFRasters!

    Parameters

    window

    image window
    sampleValues

    true to read results per sample
    interleaveValues

    true to read results as interleaved

    Return Value

    rasters

    Show on GitHub

  • Read the rasters

    Declaration

    Objective-C

    - (TIFFRasters *)readRastersWithSamples:(NSArray<NSNumber *> *)samples
                        andSampleValues:(BOOL)sampleValues
                    andInterleaveValues:(BOOL)interleaveValues;

    Swift

    func readRasters(withSamples samples: [NSNumber]!, andSampleValues sampleValues: Bool, andInterleaveValues interleaveValues: Bool) -> TIFFRasters!

    Parameters

    samples

    pixel samples to read
    sampleValues

    true to read results per sample
    interleaveValues

    true to read results as interleaved

    Return Value

    rasters

    Show on GitHub

  • Read the rasters

    Declaration

    Objective-C

    - (TIFFRasters *)readRastersWithWindow:(TIFFImageWindow *)window
                            andSamples:(NSArray<NSNumber *> *)samples
                       andSampleValues:(BOOL)sampleValues
                   andInterleaveValues:(BOOL)interleaveValues;

    Swift

    func readRasters(with window: TIFFImageWindow!, andSamples samples: [NSNumber]!, andSampleValues sampleValues: Bool, andInterleaveValues interleaveValues: Bool) -> TIFFRasters!

    Parameters

    window

    image window
    samples

    pixel samples to read
    sampleValues

    true to read results per sample
    interleaveValues

    true to read results as interleaved

    Return Value

    rasters

    Show on GitHub

  • Get the field type for the sample

    Declaration

    Objective-C

    - (enum TIFFFieldType)fieldTypeForSample:(int)sampleIndex;

    Swift

    func fieldType(forSample sampleIndex: Int32) -> TIFFFieldType

    Parameters

    sampleIndex

    sample index

    Return Value

    field type

    Show on GitHub

  • Get a short entry value

    Declaration

    Objective-C

    - (NSNumber *)shortEntryValueWithFieldTag:(enum TIFFFieldTagType)fieldTagType;

    Swift

    func shortEntryValue(with fieldTagType: TIFFFieldTagType) -> NSNumber!

    Parameters

    fieldTagType

    field tag type

    Return Value

    short value

    Show on GitHub

  • Set an unsigned short entry value for the field tag type

    Declaration

    Objective-C

    - (void)setUnsignedShortEntryValue:(unsigned short)value
                      withFieldTag:(enum TIFFFieldTagType)fieldTagType;

    Swift

    func setUnsignedShortEntryValue(_ value: UInt16, with fieldTagType: TIFFFieldTagType)

    Parameters

    value

    unsigned short value (16 bit)
    fieldTagType

    field tag type
    Show on GitHub

  • Get a number entry value

    Declaration

    Objective-C

    - (NSNumber *)numberEntryValueWithFieldTag:(enum TIFFFieldTagType)fieldTagType;

    Swift

    func numberEntryValue(with fieldTagType: TIFFFieldTagType) -> NSNumber!

    Parameters

    fieldTagType

    field tag type

    Return Value

    number value

    Show on GitHub

  • Set an unsigned long entry value for the field tag type

    Declaration

    Objective-C

    - (void)setUnsignedLongEntryValue:(unsigned long)value
                     withFieldTag:(enum TIFFFieldTagType)fieldTagType;

    Swift

    func setUnsignedLongEntryValue(_ value: UInt, with fieldTagType: TIFFFieldTagType)

    Parameters

    value

    unsigned long value (32 bit)
    fieldTagType

    field tag type
    Show on GitHub

  • Get a string entry value for the field tag type

    Declaration

    Objective-C

    - (NSString *)stringEntryValueWithFieldTag:(enum TIFFFieldTagType)fieldTagType;

    Swift

    func stringEntryValue(with fieldTagType: TIFFFieldTagType) -> String!

    Parameters

    fieldTagType

    field tag type

    Return Value

    string value

    Show on GitHub

  • Set string value for the field tag type

    Declaration

    Objective-C

    - (void)setStringEntryValue:(NSString *)value
               withFieldTag:(enum TIFFFieldTagType)fieldTagType;

    Swift

    func setStringEntryValue(_ value: String!, with fieldTagType: TIFFFieldTagType)

    Parameters

    value

    string value
    fieldTagType

    field tag type
    Show on GitHub

  • Get an short list entry value

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)shortListEntryValueWithFieldTag:
    (enum TIFFFieldTagType)fieldTagType;

    Swift

    func shortListEntryValue(with fieldTagType: TIFFFieldTagType) -> [NSNumber]!

    Parameters

    fieldTagType

    field tag type

    Return Value

    short list value

    Show on GitHub

  • Set an unsigned short list of values for the field tag type

    Declaration

    Objective-C

    - (void)setUnsignedShortListEntryValue:(NSArray<NSNumber *> *)value
                          withFieldTag:(enum TIFFFieldTagType)fieldTagType;

    Swift

    func setUnsignedShortListEntryValue(_ value: [NSNumber]!, with fieldTagType: TIFFFieldTagType)

    Parameters

    value

    unsigned shorts list
    fieldTagType

    field tag type
    Show on GitHub

  • Get the max short from short list entry values

    Declaration

    Objective-C

    - (NSNumber *)maxShortEntryValueWithFieldTag:
    (enum TIFFFieldTagType)fieldTagType;

    Swift

    func maxShortEntryValue(with fieldTagType: TIFFFieldTagType) -> NSNumber!

    Parameters

    fieldTagType

    field tag type

    Return Value

    max short value

    Show on GitHub

  • Get a number list entry value

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)numberListEntryValueWithFieldTag:
    (enum TIFFFieldTagType)fieldTagType;

    Swift

    func numberListEntryValue(with fieldTagType: TIFFFieldTagType) -> [NSNumber]!

    Parameters

    fieldTagType

    field tag type

    Return Value

    number list value

    Show on GitHub

  • Set a number list of values for the field tag type

    Declaration

    Objective-C

    - (void)setNumberListEntryValue:(NSArray<NSNumber *> *)value
                   withFieldTag:(enum TIFFFieldTagType)fieldTagType;

    Swift

    func setNumberListEntryValue(_ value: [NSNumber]!, with fieldTagType: TIFFFieldTagType)

    Parameters

    value

    number list
    fieldTagType

    field tag type
    Show on GitHub

  • Get a long list entry value

    Declaration

    Objective-C

    - (NSArray<NSNumber *> *)longListEntryValueWithFieldTag:
    (enum TIFFFieldTagType)fieldTagType;

    Swift

    func longListEntryValue(with fieldTagType: TIFFFieldTagType) -> [NSNumber]!

    Parameters

    fieldTagType

    field tag type

    Return Value

    long list value

    Show on GitHub

  • Set an unsigned long list of values for the field tag type

    Declaration

    Objective-C

    - (void)setUnsignedLongListEntryValue:(NSArray<NSNumber *> *)value
                         withFieldTag:(enum TIFFFieldTagType)fieldTagType;

    Swift

    func setUnsignedLongListEntryValue(_ value: [NSNumber]!, with fieldTagType: TIFFFieldTagType)

    Parameters

    value

    unsigned longs list
    fieldTagType

    field tag type
    Show on GitHub

  • Set rational value for the field tag type

    Declaration

    Objective-C

    - (void)setRationalEntryValue:(NSArray<NSNumber *> *)value
                 withFieldTag:(enum TIFFFieldTagType)fieldTagType;

    Swift

    func setRationalEntryValue(_ value: [NSNumber]!, with fieldTagType: TIFFFieldTagType)

    Parameters

    fieldTagType

    field tag type
    value

    long list value
    Show on GitHub

  • Size in bytes of the Image File Directory (all contiguous)

    Declaration

    Objective-C

    - (int)size;

    Swift

    func size() -> Int32

    Return Value

    size in bytes

    Show on GitHub

  • Size in bytes of the image file directory including entry values (not contiguous bytes)

    Declaration

    Objective-C

    - (int)sizeWithValues;

    Swift

    func sizeWithValues() -> Int32

    Return Value

    size in bytes

    Show on GitHub