Struct ImageAnalysis 

pub struct ImageAnalysis { /* private fields */ }

Implementations

impl ImageAnalysis

pub fn transcript(&self) -> Result<String, VisionKitError>

Examples found in repository

examples/06_image_analysis.rs (line 31)

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/04_image_analyzer.rs (line 57)

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 49)

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 has_results( &self, analysis_types: ImageAnalysisTypes, ) -> Result<bool, VisionKitError>

Examples found in repository

examples/06_image_analysis.rs (line 29)

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/02_framework_smoke.rs (line 47)

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 Drop for ImageAnalysis

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.