Skip to content
/ geqie Public

⚛️🖼 General Equation of Quantum Image Encoding (GEQIE) Framework

License

Notifications You must be signed in to change notification settings

merQlab/geqie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

optiq-geqie

image

Table of contents

Installation

While in optiq-geqie directory invoke:

pip install .

Examples

Notebooks

See the optiq-geqie/examples directory for iPython notebooks.

CLI usage

Command geqie list-encodings

geqie list-encodings

Command geqie encode

Usage: geqie encode [OPTIONS]

Custom encoding plugins:
  [all forbidden if --encoding is set, otherwise all required]
  --init TEXT
  --data TEXT
  --map TEXT

Other options:
  --encoding TEXT      Name of the encoding from 'encodings' directory
  --image TEXT         Path to the image file  [required]
  --grayscale BOOLEAN  Indication wether the image is grayscale  [default: True]
  -v, --verbose        Increase verbosity (can be used multiple times, up to
                       '-vvv')
  --help               Show this message and exit.

Example

geqie encode --encoding frqi --image assets/test_image.png

Command geqie simulate

Usage: geqie simulate [OPTIONS]

Custom encoding plugins:
  [all forbidden if --encoding is set, otherwise all required]
  --init TEXT
  --data TEXT
  --map TEXT

Other options:
  --encoding TEXT                 Name of the encoding from 'encodings'
                                  directory
  --image TEXT                    Path to the image file  [required]
  --grayscale BOOLEAN             Indication wether the image is grayscale
                                  [default: True]
  -v, --verbose                   Increase verbosity (can be used multiple
                                  times, up to '-vvv')
  --n-shots INTEGER               Number of simulation shots
  --return-qiskit-result BOOLEAN  Return results directly from qiskit  [default:
                                  False]
  --return-padded-counts BOOLEAN  Return state counts including zero-count
                                  states  [default: False]
  --help                          Show this message and exit.

Example

geqie simulate --encoding frqi --image assets/test_image.png --n-shots 1024 --return-padded-counts true

Related research