Skip to main content

Export

Struct Export 

Source
pub struct Export { /* private fields */ }
Expand description

Builder for exporting one wsi-rs-readable whole-slide image to DICOM VL WSI.

Implementations§

Source§

impl Export

Source

pub fn from_slide(source_path: impl Into<PathBuf>) -> Self

Start an export builder from a source slide path.

The builder resolves a source-aware transfer syntax in build_request or run until with_options or transfer_syntax makes the transfer syntax explicit. Direct export_dicom calls use the request options as supplied and do not perform this source-aware resolution step.

Source

pub fn to_directory(self, output_dir: impl Into<PathBuf>) -> Self

Set the output directory for generated DICOM instances.

Source

pub fn with_options(self, options: ExportOptions) -> Self

Replace export options and treat their transfer syntax as explicit.

Source

pub fn with_metadata(self, metadata: MetadataSource) -> Self

Replace metadata used for DICOM conformance fields.

Source

pub fn with_research_placeholder_metadata(self) -> Self

Use deterministic non-clinical placeholder metadata for research exports.

Source

pub fn level(self, level: u32) -> Self

Export only one source pyramid level.

Source

pub fn transfer_syntax(self, transfer_syntax: TransferSyntax) -> Self

Explicitly set the output transfer syntax.

Source

pub fn jpeg_direct_htj2k_profile(self, profile: JpegDirectHtj2kProfile) -> Self

Select the direct JPEG-to-HTJ2K coefficient path for HTJ2K exports.

Source

pub fn tile_size(self, tile_size: u32) -> Self

Set the DICOM frame tile size in pixels.

Source

pub fn jpeg_quality(self, jpeg_quality: u8) -> Self

Set JPEG Baseline fallback quality.

Source

pub fn icc_profile_policy(self, policy: IccProfilePolicy) -> Self

Set the ICC profile policy for missing source color metadata.

Source

pub fn encode_backend(self, backend: EncodeBackendPreference) -> Self

Set the runtime encode backend preference.

Source

pub fn codec_validation(self, validation: CodecValidation) -> Self

Set the runtime codec validation policy.

Source

pub fn source_device_decode(self, source_device_decode: bool) -> Self

Allow or disable device-backed source tile decode.

Source

pub fn j2k_decomposition_levels(self, levels: Option<u8>) -> Self

Override JPEG 2000 decomposition levels.

Source

pub fn gpu_encode_inflight_tiles(self, tiles: Option<usize>) -> Self

Set the optional GPU encode in-flight tile cap.

Source

pub fn gpu_encode_memory_mib(self, memory_mib: Option<u64>) -> Self

Set the optional GPU encode memory budget in MiB.

Source

pub fn gpu_pipeline_depth(self, depth: Option<usize>) -> Self

Set the optional GPU pipeline depth.

Source

pub fn gpu_row_batch_rows(self, rows: Option<usize>) -> Self

Set the optional maximum rows per GPU row batch.

Source

pub fn gpu_row_batch_target_tiles(self, tiles: Option<usize>) -> Self

Set the optional target tile count per GPU row batch.

Source

pub fn source_aware_transfer_syntax(self) -> Self

Resolve the transfer syntax from the source at run time.

Source

pub fn build_request(self) -> Result<ExportRequest, Error>

Convert the builder into an export request, resolving source-aware defaults.

Source

pub fn run(self) -> Result<ExportReport, Error>

Run the export and return a report.

Trait Implementations§

Source§

impl Clone for Export

Source§

fn clone(&self) -> Export

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Export

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more