Package org.photonvision.vision.frame.provider

Class FileFrameProvider

java.lang.Object

org.photonvision.vision.frame.FrameProvider

org.photonvision.vision.frame.provider.CpuImageProcessor

org.photonvision.vision.frame.provider.FileFrameProvider

All Implemented Interfaces:

Supplier<Frame>, Releasable

public class FileFrameProvider
extends CpuImageProcessor
implements Releasable

A FrameProvider that will read and provide an image from a path.

Nested Class Summary

Nested classes/interfaces inherited from class org.photonvision.vision.frame.provider.CpuImageProcessor

CpuImageProcessor.CapturedFrame

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_FPS

Fields inherited from class org.photonvision.vision.frame.FrameProvider

cameraPropertiesCached, sequenceID

Constructor Summary

Constructors

Constructor	Description
FileFrameProvider(String pathAsString, double fov)	Instantiates a new File frame provider.
FileFrameProvider(Path path, double fov)	Instantiates a new File frame provider.
FileFrameProvider(Path path, double fov, int maxFPS)	Instantiates a new FileFrameProvider.
FileFrameProvider(Path path, double fov, int maxFPS, CameraCalibrationCoefficients calibration)
FileFrameProvider(Path path, double fov, CameraCalibrationCoefficients calibration)

Method Summary

Modifier and Type	Method	Description
boolean	checkCameraConnected()
CpuImageProcessor.CapturedFrame	getInputMat()
String	getName()
boolean	hasConnected()	Returns if the camera has connected at some point.
boolean	isConnected()
void	release()

Methods inherited from class org.photonvision.vision.frame.provider.CpuImageProcessor

get, requestFrameCopies, requestFrameRotation, requestFrameThresholdType, requestHsvSettings

Methods inherited from class org.photonvision.vision.frame.FrameProvider

onCameraConnected

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAX_FPS

public static final int MAX_FPS

See Also:

• Constant Field Values

Constructor Details

FileFrameProvider

public FileFrameProvider(Path path,
 double fov,
 int maxFPS)

Instantiates a new FileFrameProvider.

Parameters:

path - The path of the image to read from.

fov - The fov of the image.

maxFPS - The max framerate to provide the image at.

FileFrameProvider

public FileFrameProvider(Path path,
 double fov,
 CameraCalibrationCoefficients calibration)

FileFrameProvider

public FileFrameProvider(Path path,
 double fov,
 int maxFPS,
 CameraCalibrationCoefficients calibration)

FileFrameProvider

public FileFrameProvider(String pathAsString,
 double fov)

Instantiates a new File frame provider.

Parameters:

pathAsString - The path of the image to read from as a string.

fov - The fov of the image.

FileFrameProvider

public FileFrameProvider(Path path,
 double fov)

Instantiates a new File frame provider.

Parameters:

path - The path of the image to read from.

fov - The fov of the image.

Method Details

getInputMat

public CpuImageProcessor.CapturedFrame getInputMat()

getName

public String getName()

Specified by:

getName in class FrameProvider

release

public void release()

Specified by:

release in interface Releasable

checkCameraConnected

public boolean checkCameraConnected()

Specified by:

checkCameraConnected in class FrameProvider

isConnected

public boolean isConnected()

Specified by:

isConnected in class FrameProvider

hasConnected

public boolean hasConnected()

Description copied from class: FrameProvider

Returns if the camera has connected at some point. This is not if it is currently connected.

Overrides:

hasConnected in class FrameProvider