libdcp
Public Member Functions | Public Attributes | List of all members
dcp::EqualityOptions Class Reference

A class to describe what "equality" means for a particular test. More...

#include <equality_options.h>

Public Member Functions

 EqualityOptions ()=default
 

Public Attributes

double max_mean_pixel_error = 0
 
double max_std_dev_pixel_error = 0
 
int max_audio_sample_error = 0
 
bool cpl_annotation_texts_can_differ = false
 
bool reel_annotation_texts_can_differ = false
 
bool reel_hashes_can_differ = false
 
bool asset_hashes_can_differ = false
 
bool issue_dates_can_differ = false
 
bool load_font_nodes_can_differ = false
 
bool sound_assets_can_differ = false
 
bool keep_going = false
 
bool export_differing_texts = false
 
float max_text_vertical_position_error = 0
 

Detailed Description

A class to describe what "equality" means for a particular test.

When comparing things, we want to be able to ignore some differences; this class expresses those differences.

It also contains some settings for how the comparison should be done.

Definition at line 55 of file equality_options.h.

Constructor & Destructor Documentation

◆ EqualityOptions()

dcp::EqualityOptions::EqualityOptions ( )
default

Construct an EqualityOptions where nothing at all can differ

Member Data Documentation

◆ asset_hashes_can_differ

bool dcp::EqualityOptions::asset_hashes_can_differ = false

true if asset hashes can differ

Definition at line 74 of file equality_options.h.

◆ cpl_annotation_texts_can_differ

bool dcp::EqualityOptions::cpl_annotation_texts_can_differ = false

true if the <AnnotationText> nodes of CPLs are allowed to differ

Definition at line 68 of file equality_options.h.

◆ export_differing_texts

bool dcp::EqualityOptions::export_differing_texts = false

true to save the last pair of different image subtitles/captions to the current working directory

Definition at line 81 of file equality_options.h.

◆ issue_dates_can_differ

bool dcp::EqualityOptions::issue_dates_can_differ = false

true if IssueDate nodes can differ

Definition at line 76 of file equality_options.h.

◆ max_audio_sample_error

int dcp::EqualityOptions::max_audio_sample_error = 0

The maximum difference in audio sample value between two soundtracks

Definition at line 66 of file equality_options.h.

◆ max_mean_pixel_error

double dcp::EqualityOptions::max_mean_pixel_error = 0

The maximum allowable mean difference in pixel value between two images

Definition at line 62 of file equality_options.h.

◆ max_std_dev_pixel_error

double dcp::EqualityOptions::max_std_dev_pixel_error = 0

The maximum standard deviation of the differences in pixel value between two images

Definition at line 64 of file equality_options.h.

◆ max_text_vertical_position_error

float dcp::EqualityOptions::max_text_vertical_position_error = 0

The maximum allowable absolute difference between the vertical position of texts

Definition at line 83 of file equality_options.h.

◆ reel_annotation_texts_can_differ

bool dcp::EqualityOptions::reel_annotation_texts_can_differ = false

true if the <AnnotationText> nodes of Reels are allowed to differ

Definition at line 70 of file equality_options.h.

◆ reel_hashes_can_differ

bool dcp::EqualityOptions::reel_hashes_can_differ = false

true if <Hash>es in Reels can differ

Definition at line 72 of file equality_options.h.


The documentation for this class was generated from the following file: