cpp_decomp: IFC_object Decompression

View source: R/RcppExports.R

cpp_decompR Documentation

IFC_object Decompression

Description

Operates decompression of compressed image stored in TIFF file.

Arguments

fname

string, path to file.

offset

std::size_t, position of the beginning of compressed image.

nbytes

uint32_t, number of bytes of compressed image.

imgWidth

R_len_t, Width of the decompressed image. Default is 1.

imgHeight

R_len_t, Height of the decompressed image. Default is 1.

nb_channels

R_len_t, number of channels of the decompressed image. Default is 1.

removal

uint8_t, object removal method. Only apply for 30818 compression. Default is 0.
-1, for clipped removal: height OR width clipped pixels will be set to -1.
-2, height clipped removal: height clipped pixels will be set to -1.
-3, width clipped removal: width clipped pixels will be set to -1.
-4, only keep background: background pixels will be set to 1 and all others to 0.
-5, only keep foreground: foreground pixels will be set to 1 and all others to 0.

compression

uint32_t, compression algorithm used. Default is 30818.

verbose

bool, whether to display information (use for debugging purpose). Default is false.

Source

For image decompression, Lee Kamentsky's code porting from https://github.com/ome/bioformats/blob/4146b9a1797501f0fec7d6cfe69124959bff96ee/components/formats-bsd/src/loci/formats/in/FlowSightReader.java
cited in https://linkinghub.elsevier.com/retrieve/pii/S1046-2023(16)30291-2
⁠ BSD implementations of Bio-Formats readers and writers Copyright (C) 2005 - 2017 Open Microscopy Environment: - Board of Regents of the University of Wisconsin-Madison - Glencoe Software, Inc. - University of Dundee Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ⁠


gitdemont/IFC documentation built on Feb. 20, 2025, 12:55 a.m.