Struct ImageAnalyzerConfiguration 

pub struct ImageAnalyzerConfiguration { /* private fields */ }

Implementations

impl ImageAnalyzerConfiguration

pub fn new(analysis_types: ImageAnalysisTypes) -> Self

Examples found in repository

examples/06_image_analysis.rs (lines 22-24)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    if !ImageAnalyzer::is_supported() {
        println!("ImageAnalyzer is not supported on this Mac");
        return Ok(());
    }

    let analyzer = ImageAnalyzer::new()?;
    let analysis = analyzer.analyze_cg_image_at_path(
        asset_path(),
        ImageOrientation::Up,
        &ImageAnalyzerConfiguration::new(
            ImageAnalysisTypes::TEXT | ImageAnalysisTypes::MACHINE_READABLE_CODE,
        ),
    )?;

    println!(
        "has text results: {}",
        analysis.has_results(ImageAnalysisTypes::TEXT)?
    );
    println!("transcript: {}", analysis.transcript()?);
    Ok(())
}

examples/05_live_text_interaction.rs (line 23)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    if !ImageAnalyzer::is_supported() {
        println!("ImageAnalyzer is not supported on this Mac");
        return Ok(());
    }

    let asset_path = asset_path();
    let analyzer = ImageAnalyzer::new()?;
    let analysis = analyzer.analyze_image_at_path(
        &asset_path,
        ImageOrientation::Up,
        &ImageAnalyzerConfiguration::new(ImageAnalysisTypes::TEXT),
    )?;

    let interaction = LiveTextInteraction::new()?;
    interaction.track_image_at_path(&asset_path)?;
    interaction.set_analysis(&analysis)?;
    interaction.set_preferred_interaction_types(LiveTextInteractionTypes::AUTOMATIC_TEXT_ONLY)?;
    interaction.set_selectable_items_highlighted(true)?;
    let rect = interaction.contents_rect()?;
    println!("contents rect: {rect:?}");
    let overlay_text = interaction.text();
    println!("overlay text: {overlay_text:?}");
    println!(
        "live text button visible: {}",
        interaction.live_text_button_visible()?
    );
    println!(
        "supplementary hidden: {}",
        interaction.is_supplementary_interface_hidden()?
    );
    Ok(())
}

examples/04_image_analyzer.rs (lines 13-15)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let configuration = ImageAnalyzerConfiguration::new(
        ImageAnalysisTypes::TEXT | ImageAnalysisTypes::MACHINE_READABLE_CODE,
    )
    .with_locales(["en-US"]);
    println!(
        "supported OCR languages: {}",
        ImageAnalyzer::supported_text_recognition_languages()?.len()
    );

    if !ImageAnalyzer::is_supported() {
        println!("ImageAnalyzer is not supported on this Mac");
        return Ok(());
    }

    let analyzer = ImageAnalyzer::new()?;
    let asset_path = asset_path();
    let analyses = [
        (
            "imageAt:url",
            analyzer.analyze_image_at_path(&asset_path, ImageOrientation::Up, &configuration)?,
        ),
        (
            "nsimage",
            analyzer.analyze_ns_image_at_path(&asset_path, ImageOrientation::Up, &configuration)?,
        ),
        (
            "cgimage",
            analyzer.analyze_cg_image_at_path(&asset_path, ImageOrientation::Up, &configuration)?,
        ),
        (
            "ciimage",
            analyzer.analyze_ci_image_at_path(&asset_path, ImageOrientation::Up, &configuration)?,
        ),
        (
            "pixelBuffer",
            analyzer.analyze_pixel_buffer_at_path(
                &asset_path,
                ImageOrientation::Up,
                &configuration,
            )?,
        ),
    ];

    for (label, analysis) in analyses {
        println!("{label}: {}", analysis.transcript()?);
    }
    Ok(())
}

examples/02_framework_smoke.rs (lines 37-39)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("== VisionKit.framework smoke ==");
    println!("ImageAnalyzer supported: {}", ImageAnalyzer::is_supported());
    println!(
        "document camera available on macOS: {}",
        VNDocumentCameraViewController::is_available_on_current_platform()?
    );
    println!(
        "data scanner available on macOS: {}",
        DataScannerViewController::is_available_on_current_platform()?
    );

    let languages = ImageAnalyzer::supported_text_recognition_languages()?;
    println!("supported OCR languages: {}", languages.len());
    println!(
        "sample OCR languages: {:?}",
        languages.iter().take(10).collect::<Vec<_>>()
    );

    if !ImageAnalyzer::is_supported() {
        println!("ImageAnalyzer is not supported on this Mac");
        return Ok(());
    }

    let analyzer = ImageAnalyzer::new()?;
    let configuration = ImageAnalyzerConfiguration::new(
        ImageAnalysisTypes::TEXT | ImageAnalysisTypes::MACHINE_READABLE_CODE,
    )
    .with_locales(["en-US"]);
    let asset_path = asset_path();
    let analysis =
        analyzer.analyze_image_at_path(&asset_path, ImageOrientation::Up, &configuration)?;

    println!(
        "has text results: {}",
        analysis.has_results(ImageAnalysisTypes::TEXT)?
    );
    let transcript = analysis.transcript()?;
    println!("transcript: {transcript:?}");

    let interaction = LiveTextInteraction::new()?;
    interaction.track_image_at_path(&asset_path)?;
    interaction.set_analysis(&analysis)?;
    println!(
        "overlay preferred types: {}",
        interaction.preferred_interaction_types()?.bits()
    );
    let overlay_text = interaction.text();
    println!("overlay text: {overlay_text:?}");
    Ok(())
}

pub fn analysis_types(&self) -> ImageAnalysisTypes

pub fn locales(&self) -> &[String]

pub fn with_locales<I, S>(self, locales: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Examples found in repository

examples/04_image_analyzer.rs (line 16)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let configuration = ImageAnalyzerConfiguration::new(
        ImageAnalysisTypes::TEXT | ImageAnalysisTypes::MACHINE_READABLE_CODE,
    )
    .with_locales(["en-US"]);
    println!(
        "supported OCR languages: {}",
        ImageAnalyzer::supported_text_recognition_languages()?.len()
    );

    if !ImageAnalyzer::is_supported() {
        println!("ImageAnalyzer is not supported on this Mac");
        return Ok(());
    }

    let analyzer = ImageAnalyzer::new()?;
    let asset_path = asset_path();
    let analyses = [
        (
            "imageAt:url",
            analyzer.analyze_image_at_path(&asset_path, ImageOrientation::Up, &configuration)?,
        ),
        (
            "nsimage",
            analyzer.analyze_ns_image_at_path(&asset_path, ImageOrientation::Up, &configuration)?,
        ),
        (
            "cgimage",
            analyzer.analyze_cg_image_at_path(&asset_path, ImageOrientation::Up, &configuration)?,
        ),
        (
            "ciimage",
            analyzer.analyze_ci_image_at_path(&asset_path, ImageOrientation::Up, &configuration)?,
        ),
        (
            "pixelBuffer",
            analyzer.analyze_pixel_buffer_at_path(
                &asset_path,
                ImageOrientation::Up,
                &configuration,
            )?,
        ),
    ];

    for (label, analysis) in analyses {
        println!("{label}: {}", analysis.transcript()?);
    }
    Ok(())
}

examples/02_framework_smoke.rs (line 40)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("== VisionKit.framework smoke ==");
    println!("ImageAnalyzer supported: {}", ImageAnalyzer::is_supported());
    println!(
        "document camera available on macOS: {}",
        VNDocumentCameraViewController::is_available_on_current_platform()?
    );
    println!(
        "data scanner available on macOS: {}",
        DataScannerViewController::is_available_on_current_platform()?
    );

    let languages = ImageAnalyzer::supported_text_recognition_languages()?;
    println!("supported OCR languages: {}", languages.len());
    println!(
        "sample OCR languages: {:?}",
        languages.iter().take(10).collect::<Vec<_>>()
    );

    if !ImageAnalyzer::is_supported() {
        println!("ImageAnalyzer is not supported on this Mac");
        return Ok(());
    }

    let analyzer = ImageAnalyzer::new()?;
    let configuration = ImageAnalyzerConfiguration::new(
        ImageAnalysisTypes::TEXT | ImageAnalysisTypes::MACHINE_READABLE_CODE,
    )
    .with_locales(["en-US"]);
    let asset_path = asset_path();
    let analysis =
        analyzer.analyze_image_at_path(&asset_path, ImageOrientation::Up, &configuration)?;

    println!(
        "has text results: {}",
        analysis.has_results(ImageAnalysisTypes::TEXT)?
    );
    let transcript = analysis.transcript()?;
    println!("transcript: {transcript:?}");

    let interaction = LiveTextInteraction::new()?;
    interaction.track_image_at_path(&asset_path)?;
    interaction.set_analysis(&analysis)?;
    println!(
        "overlay preferred types: {}",
        interaction.preferred_interaction_types()?.bits()
    );
    let overlay_text = interaction.text();
    println!("overlay text: {overlay_text:?}");
    Ok(())
}

Trait Implementations

impl Clone for ImageAnalyzerConfiguration

fn clone(&self) -> ImageAnalyzerConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImageAnalyzerConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageAnalyzerConfiguration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ImageAnalyzerConfiguration

fn eq(&self, other: &ImageAnalyzerConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ImageAnalyzerConfiguration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ImageAnalyzerConfiguration

impl StructuralPartialEq for ImageAnalyzerConfiguration