find_envelopes: Finding Envelopes for Two Traces

View source: R/userFunctions.R

find_envelopesR Documentation

Finding Envelopes for Two Traces

Description

Finding Envelopes for Two Traces

Usage

find_envelopes(
  imageMatrix,
  rolledImage,
  bottomCut,
  topCut,
  returnType,
  sepDist = 10,
  max_roc = 25,
  maxNoise = 100,
  improveTTopEnvelope = data.frame(x = NA, y = NA),
  improveBTopEnvelope = data.frame(x = NA, y = NA),
  improveTBottomEnvelope = data.frame(x = NA, y = NA),
  improveBBottomEnvelope = data.frame(x = NA, y = NA),
  trimTop = 0,
  trimBottom = 0
)

Arguments

imageMatrix

ImageMatrix from import_process_image()

rolledImage

the image rolled by mean_roll_image()

bottomCut

a point that is the height of a horizontal line between the timing marks and the bottom trace

topCut

Top cutoff between the date writing and the top trace

returnType

Either "MatrixScaled" used if you are manipulating with imageMatrix, "PlottingScaled" used if you are plotting the imageMatrix with overlay of these lines "RolledImageScaled" used if you are overlaying the rolled image with these lines

sepDist

how far you want the envelope to be below the line you are tracing

max_roc

maximum rate of change allowed between two pixels on the line before deemed as noise

maxNoise

the length of creating points allowed before considered to be off of the trace

improveTTopEnvelope

data.frame of col x and col y representing points for top of the top envelope pair doesn't need to be a point for each column in original picture, will fill in the blanks

improveBTopEnvelope

data.frame of col x and col y representing points for Bottom of the top envelope pair doesn't need to be a point for each column in original picture, will fill in the blanks

improveTBottomEnvelope

data.frame of col x and col y representing points for top of the bottom envelope pair doesn't need to be a point for each column in original picture, will fill in the blanks

improveBBottomEnvelope

data.frame of col x and col y representing points for bottom of the bottom envelope pair doesn't need to be a point for each column in original picture, will fill in the blanks

trimTop

how much has been trimmed by TISI or TIS

trimBottom

how much has been trimmed by TISI or TIS

Value

list of all four envelopes


Bott-binc/magnetoPackage2020 documentation built on Oct. 12, 2024, 7:49 p.m.