c4d.modules.motiontracker.MtFootageData

class c4d.modules.motiontracker.MtFootageData

New in version R18.020.

Methods Signatures

MtFootageData.GetFootageName(self)

Retrieves the filename of the footage (the first frame if an image sequence).

MtFootageData.GetFirstFrameNumber(self)

Retrieves the frame number of the first frame in the footage. -1 if no footage loaded.

MtFootageData.GetLastFrameNumber(self)

Retrieves the last number of the first frame in the footage. -1 if no footage loaded.

MtFootageData.GetResolutionWidthPix(self, originalRes)

Retrieves the width in pixels of the footage.

MtFootageData.GetResolutionHeightPix(self, originalRes)

Retrieves the height in pixels of the footage.

MtFootageData.GetResolutionAspectRatio(self)

Retrieves the ratio of the horizontal to vertical resolution. Ignores pixel aspect ratio.

MtFootageData.GetImageAspectRatio(self)

Retrieves the aspect ratio of the footage including effects of pixel aspect ratio.

MtFootageData.GetPixelAspectRatio(self)

Retrieves the pixel aspect ratio of the footage.

MtFootageData.GetDownsamplingFactor(self)

Retrieves the downsampling factor used for the footage.

Methods Documentation

MtFootageData.GetFootageName(self)

Retrieves the filename of the footage (the first frame if an image sequence).

Return type

str

Returns

The filename.

MtFootageData.GetFirstFrameNumber(self)

Retrieves the frame number of the first frame in the footage. -1 if no footage loaded.

Return type

int

Returns

The first frame number.

MtFootageData.GetLastFrameNumber(self)

Retrieves the last number of the first frame in the footage. -1 if no footage loaded.

Return type

int

Returns

The last frame number.

MtFootageData.GetResolutionWidthPix(self, originalRes)

Retrieves the width in pixels of the footage.

Parameters

originalRes (int) –

If True, returns the original resolution of the footage.
If False, returns the downsampled resolution.

Return type

int

Returns

The width of footage in pixels.

MtFootageData.GetResolutionHeightPix(self, originalRes)

Retrieves the height in pixels of the footage.

Parameters

originalRes (int) –

If True, returns the original resolution of the footage.
If False, returns the downsampled resolution.

Return type

int

Returns

The height of footage in pixels.

MtFootageData.GetResolutionAspectRatio(self)

Retrieves the ratio of the horizontal to vertical resolution. Ignores pixel aspect ratio.

Return type

float

Returns

The aspect ratio from resolution.

MtFootageData.GetImageAspectRatio(self)

Retrieves the aspect ratio of the footage including effects of pixel aspect ratio.

Return type

float

Returns

The image aspect ratio.

MtFootageData.GetPixelAspectRatio(self)

Retrieves the pixel aspect ratio of the footage.

Return type

float

Returns

The pixel aspect ratio.

MtFootageData.GetDownsamplingFactor(self)

Retrieves the downsampling factor used for the footage.

Return type

float

Returns

The downsampling factor.