validateVariables: Validate Function Arguments

In DragonDuck/MaxContrastProjection: Perform a maximum contrast projection of 3D images along the z-dimension into 2D

Description

Validate the function arguments based on predefined rules. This function has no application for users and serves only to ensure correct variables. It either returns TRUE if all variables conform to the rules or stops execution in case one of the conditions is not met.

Usage

validateVariables(imageStack, image, w_x, w_y, smoothing, brushShape, 
    projType, interpolation, contrastStack, indexMap, fix.gaussian.blur, 
    blur.size, return.all)

Arguments

imageStack	A numeric 3D array-like
image	A 2D array-like
w_x	A numeric value
w_y	A numeric value
smoothing	An integer value
brushShape	A string
projType	A string
interpolation	An integer value
contrastStack	A numeric 3D array-like
indexMap	A numeric 2D array-like. Must always be validated simultaneously with imageStack
fix.gaussian.blur	A logical parameter, or one which can be coerced to a logical value
blur.size	An integer value
return.all	A logical parameter, or one which can be coerced to a logical value

Value

A boolean indicating that the function ran without error.

Author(s)

Jan Sauer

Examples

print(validateVariables)

DragonDuck/MaxContrastProjection documentation built on May 6, 2019, 2:54 p.m.