Difference between revisions of "Example Render QR Code"

From BoofCV
Jump to navigationJump to search
m
m
 
(3 intermediate revisions by the same user not shown)
Line 8: Line 8:


Example Code:
Example Code:
* [https://github.com/lessthanoptimal/BoofCV/blob/v0.28/examples/src/main/java/boofcv/examples/fiducial/ExampleRenderQrCode.java ExampleRenderQrCode.java]
* [https://github.com/lessthanoptimal/BoofCV/blob/v0.40/examples/src/main/java/boofcv/examples/fiducial/ExampleRenderQrCode.java ExampleRenderQrCode.java]


Concepts:
Concepts:
Line 28: Line 28:
  * It's also easy to extending the rendering tools to support other file formats.
  * It's also easy to extending the rendering tools to support other file formats.
  *
  *
* @author Peter Abeles
  * @see boofcv.alg.fiducial.qrcode.QrCodeGenerator
  * @see boofcv.alg.fiducial.qrcode.QrCodeGenerator
*
* @author Peter Abeles
  */
  */
public class ExampleRenderQrCode
public class ExampleRenderQrCode {
{
public static void main( String[] args ) {
public static void main(String[] args) {
 
// Uses a flow pattern to specify the QR Code. You can control all aspects of the QR
// Uses a flow pattern to specify the QR Code. You can control all aspects of the QR
// like specifying the version, mask, and message types or let it select all of that for you.
// like specifying the version, mask, and message types or let it select all of that for you.
Line 41: Line 38:
setError(QrCode.ErrorLevel.M).
setError(QrCode.ErrorLevel.M).
addAutomatic("This is a Test ん鞠").fixate();
addAutomatic("This is a Test ん鞠").fixate();
// NOTE: The final function you call must be fixate() that's how it knows its done
// NOTE: The final function you call must be fixate(), that's how it knows it's done


// QrCodeGenerator is the base class with all the logic and the children tell it how to
// QrCodeGenerator is the base class with all the logic and the children tell it how to
// write in a specific format. QrCodeGeneratorImage is included with BoofCV and is used
// write in a specific format. QrCodeGeneratorImage is included with BoofCV and is used
// to creates images
// to create images
QrCodeGeneratorImage render = new QrCodeGeneratorImage(20);
var render = new QrCodeGeneratorImage(/* pixel per module */ 20);


render.render(qr);
render.render(qr);


// Convert it to a BufferedImage for display purposes
// Convert it to a BufferedImage for display purposes
BufferedImage image = ConvertBufferedImage.convertTo(render.getGray(),null);
BufferedImage image = ConvertBufferedImage.convertTo(render.getGray(), null);
ShowImages.showWindow(image,"Rendered QR Code", true);


// You can also save it to disk by uncommenting the line below
// You can also save it to disk by uncommenting the line below
// UtilImageIO.saveImage(image,"qrcode.png");
// UtilImageIO.saveImage(image, "qrcode.png");


// WARNING! This rendered image lacks the white border which is required to be a compliant
// Display the image
//          QR Code. As of this writing BoofCV's implementation might not be able to handle
ShowImages.showWindow(image, "Rendered QR Code", true);
//          this image unless you add a white border.
}
}
}
}
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 14:45, 17 January 2022

This example shows how a QR Codes can be rendered into an image. Its easy to adapt the approach here for just about any file format.

Example Code:

Concepts:

  • Fiducials
  • QR Codes

Relevant Examples/Tutorials:

Relevant Videos:

Example Code

/**
 * A simple API is provided for creating your own QR Codes. Used extensively in BoofCV for testing purposes.
 * It's also easy to extending the rendering tools to support other file formats.
 *
 * @author Peter Abeles
 * @see boofcv.alg.fiducial.qrcode.QrCodeGenerator
 */
public class ExampleRenderQrCode {
	public static void main( String[] args ) {
		// Uses a flow pattern to specify the QR Code. You can control all aspects of the QR
		// like specifying the version, mask, and message types or let it select all of that for you.
		QrCode qr = new QrCodeEncoder().
				setError(QrCode.ErrorLevel.M).
				addAutomatic("This is a Test ん鞠").fixate();
		// NOTE: The final function you call must be fixate(), that's how it knows it's done

		// QrCodeGenerator is the base class with all the logic and the children tell it how to
		// write in a specific format. QrCodeGeneratorImage is included with BoofCV and is used
		// to create images
		var render = new QrCodeGeneratorImage(/* pixel per module */ 20);

		render.render(qr);

		// Convert it to a BufferedImage for display purposes
		BufferedImage image = ConvertBufferedImage.convertTo(render.getGray(), null);

		// You can also save it to disk by uncommenting the line below
//		UtilImageIO.saveImage(image, "qrcode.png");

		// Display the image
		ShowImages.showWindow(image, "Rendered QR Code", true);
	}
}