speckle_frame: Selected frame from binary file

View source: R/speckle_frame.R

speckle_frameR Documentation

Selected frame from binary file

Description

Get specified frame as matrix from binary file

Usage

speckle_frame(
  data_file = NULL,
  frame = 1,
  x_pix = 512,
  y_pix = 512,
  type = "int",
  byte = 2
)

Arguments

data_file

a character string with the path name to a file.

frame

an integer.

x_pix

a number of x pixels (default is 512).

y_pix

a number of y pixels (default is 512).

type

a string 'int' or 'num' (default is 'int').

byte

a number of bytes in pixel (default is 2).

Value

Matrix with given frame.

Examples

## Not run: 
# On Unix-like operating systems only
# Read frame number 2 from file to matrix
obj_filename <- system.file("extdata", "ads15182_550_2_frames.dat", package = "specklestar")
frame2 <- speckle_frame(obj_filename, 2)

## End(Not run)

drastega/specklestar documentation built on Nov. 20, 2023, 8:21 p.m.